Update a cardholder - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

id

string

required

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

billing

object

optional

The cardholder’s billing information.

address

object

optional

The cardholder’s billing address.

email

string

optional

The cardholder’s email address.

phone_number

string

optional

The cardholder’s phone number. This is required for all cardholders who will be creating EU cards.

metadata

array [object]

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

company

object

optional

Additional information about a company cardholder.

tax_id_provided

boolean

optional

Whether the company’s business ID number was provided.

individual

object

optional

Additional information about an individual cardholder.

card_issuing

object

optional

Information related to the card_issuing program for this cardholder.

dob

object

optional

The date of birth of this cardholder.

first_name

string

optional

The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

last_name

string

optional

The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

verification

object

optional

An identifying document, either a passport or local ID card.

spending_controls

object

optional

Rules that control spending across this cardholder’s cards.

spending_limits

object

optional

Limit spending with amount-based rules that apply across this cardholder’s cards.

spending_limits_currency

string

optional

Currency of the amounts within spending_limits.

status

enum<string>

optional

Specifies whether to permit authorizations on this cardholder’s cards.

Allowed values:

activeinactiveblocked

Example

{
  "billing": {
    "address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    }
  },
  "email": "string",
  "phone_number": "string",
  "metadata": [
    {}
  ],
  "company": {
    "tax_id_provided": true
  },
  "individual": {
    "card_issuing": {
      "user_terms_acceptance": {
        "date": 0,
        "ip": "string",
        "user_agent": "string"
      }
    },
    "dob": {
      "day": 0,
      "month": 0,
      "year": 0
    },
    "first_name": "string",
    "last_name": "string",
    "verification": {
      "document": {
        "back": "string",
        "front": "string"
      }
    }
  },
  "spending_controls": {
    "spending_limits": {
      "amount": 0,
      "interval": "per_authorization"
    },
    "spending_limits_currency": "string"
  },
  "status": "active"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apitest.wooshpay.com/v1/issuing/cardholders/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "billing": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        }
    },
    "email": "string",
    "phone_number": "string",
    "metadata": [
        {}
    ],
    "company": {
        "tax_id_provided": true
    },
    "individual": {
        "card_issuing": {
            "user_terms_acceptance": {
                "date": 0,
                "ip": "string",
                "user_agent": "string"
            }
        },
        "dob": {
            "day": 0,
            "month": 0,
            "year": 0
        },
        "first_name": "string",
        "last_name": "string",
        "verification": {
            "document": {
                "back": "string",
                "front": "string"
            }
        }
    },
    "spending_controls": {
        "spending_limits": {
            "amount": 0,
            "interval": "per_authorization"
        },
        "spending_limits_currency": "string"
    },
    "status": "active"
}'

Responses

🟢200OK

application/json

Body

id

string

optional

Unique identifier for the object.

object

string

optional

Value is "issuing.cardholder". String representing the object’s type. Objects of the same type share the same value.

billing

object

optional

The cardholder’s billing information.

address

object

optional

The cardholder’s billing address.

name

string

optional

The cardholder’s name. This will be printed on cards issued to them.

email

string

optional

The cardholder’s email address.

phone_number

string

optional

The cardholder’s phone number. This is required for all cardholders who will be creating EU cards.

metadata

array [object]

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

company

object

optional

Additional information about a company cardholder.

tax_id_provided

boolean

optional

Whether the company’s business ID number was provided.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

individual

object

optional

Additional information about an individual cardholder.

card_issuing

object

optional

Information related to the card_issuing program for this cardholder.

dob

object

optional

The date of birth of this cardholder.

first_name

string

optional

The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

last_name

string

optional

The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

verification

object

optional

An identifying document, either a passport or local ID card.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

spending_controls

object

optional

Rules that control spending across this cardholder’s cards.

spending_limits

object

optional

Limit spending with amount-based rules that apply across this cardholder’s cards.

spending_limits_currency

string

optional

Currency of the amounts within spending_limits.

status

enum<string>

optional

Specifies whether to permit authorizations on this cardholder’s cards.

Allowed values:

activeinactiveblocked

type

enum<string>

optional

One of individual or company.

Allowed values:

individualcompany

Example

{
  "id": "string",
  "object": "string",
  "billing": {
    "address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    }
  },
  "name": "string",
  "email": "string",
  "phone_number": "string",
  "metadata": [
    {}
  ],
  "company": {
    "tax_id_provided": true
  },
  "created": 0,
  "individual": {
    "card_issuing": {
      "user_terms_acceptance": {
        "date": 0,
        "ip": "string",
        "user_agent": "string"
      }
    },
    "dob": {
      "day": 0,
      "month": 0,
      "year": 0
    },
    "first_name": "string",
    "last_name": "string",
    "verification": {
      "document": {
        "back": "string",
        "front": "string"
      }
    }
  },
  "livemode": true,
  "spending_controls": {
    "spending_limits": {
      "amount": 0,
      "interval": "per_authorization"
    },
    "spending_limits_currency": "string"
  },
  "status": "active",
  "type": "individual"
}