API Reference

Add or Validate External Bank Card

post
https://example.com/programs//externalcards

Adds or validates an external bank card for a customer using encrypted card data. This endpoint is intended for external and general use.

Path Params
string
required

The program code for the external card context.

Body Params

The encrypted request payload containing external card details. See Gd.Bos.DataTransfer.Request.AddExternalCardEncryptedRequest for details.

encryptedExternalCardData
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

string | null

The unique identifier for the account to which the external card will be added.

string | null

The first name of the cardholder.

string | null

The last name of the cardholder.

string | null

The nickname for the external card.

string | null

The action to perform (e.g., "add", "update", "remove").

string | null

The first line of the cardholder's address.

string | null

The second line of the cardholder's address (optional).

string | null

The city of the cardholder's address.

string | null

The state or province of the cardholder's address.

string | null

The ZIP or postal code of the cardholder's address.

Headers
string
required

A unique request identifier for tracking and logging.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago