Skip to main content
POST
Submit an external card session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId
string
required

ID of the user.

Pattern: ^user_[A-Za-z0-9]+$
cardSessionId
string
required

Public ID of the external card session (prefixed with ecs_)

Body

application/json

Counter party and card details collected by the hosted session. Omit counterParty if the session was created with a counterPartyId.

Submits the collected counter party and card details for an external card session. counterParty is required unless the session was created with a counterPartyId, in which case it must be omitted.

externalCard
object
required

Card details to tokenize. The card number is tokenized with the card provider and never stored in plaintext; only the last four digits are retained.

counterParty
object

An individual counter party. Only type, firstName, and lastName are always required; the other fields become required depending on what is later attached (external wallet needs the name only; external account needs phoneNumber, email, dateOfBirth, taxId, taxIdType, nationality, address).

Response

External card session submitted successfully. The counter party and external card have been created.

The counter party and external card created from a submitted session.

externalCardId
string

Public ID of the created external card (prefixed with extcrd_).

Example:

"extcrd_2mNpXwZ7bV1aLcs3Kf9dQ"

counterPartyId
string

Public ID of the counter party the card was created under (prefixed with cpty_).

Example:

"cpty_7bV1aLcs3Kf9dQ2mNpXwZ"