GRgreendot
ExternalCards

Add or Validate External Bank Card

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

post/programs/{programCode}/externalcards

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code for the external card context.

Headers

X-GD-RequestIdstring required

A unique request identifier for tracking and logging.

Request body

accountIdentifierstring nullable

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

firstNamestring nullable

The first name of the cardholder.

lastNamestring nullable

The last name of the cardholder.

nickNamestring nullable

The nickname for the external card.

actionstring nullable

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

address1string nullable

The first line of the cardholder's address.

address2string nullable

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

citystring nullable

The city of the cardholder's address.

statestring nullable

The state or province of the cardholder's address.

zipstring nullable

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

Response

Created

bankNamestring nullable

The name of the bank that issued the external card.

networkstring nullable

The payment network associated with the card (e.g., Visa, Mastercard).

fundingEligibleboolean nullable

Indicates whether the card is eligible for funding (can receive deposits).

withdrawalEligibleboolean nullable

Indicates whether the card is eligible for withdrawal (can be used for cash-out).

accountExternalCardIdentifierstring uuid nullable

Unique identifier for the external card account, used for future operations.

Changes

No recorded changes to this operation across all 2 revisions of this API.