Skip to main content
POST
Creating a card external account sends the full card number and security code through your systems, which requires your organization to be PCI DSS compliant. If it isn’t, link cards through the Payment Widget, which collects the card details itself, with its Transaction - Select Deposit Origin or Transaction - Select Withdrawal Destination flow.
You can optionally include custom entity metadata in the metadata field to store your own business data (e.g., cardholder name, tracking information, custom labels). If not provided during creation, you can add it later using Set metadata.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Scopes

core.external-accounts:create

Grants access to create external accounts

Body

application/json
type
enum<string>
required

The type of the external account.

Available options:
card
label
string
required

The label of the external account.

Maximum string length: 140
Pattern: ^\S.*\S$|^\S$
number
string
required

The number of the card.

Pattern: ^[0-9]{12,19}$
securityCode
string
required

The security code of the card.

Pattern: ^[0-9]{3,3}$
expiryDate
object
required
metadata
object

Additional data for the external account.

Response

External account created.

externalAccount
object
required
errors
object

Additional contextual errors that occurred while processing the request.