Bulk-Issued Card Personalized Webhook

The BULK_ISSUED_CARD_PERSONALIZED webhook is sent when a card issued in bulk is connected to a wallet contact.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Note
  Inside the data object, some webhooks have another created_at field that refers to a different event.
- data
- Contains the actual data of the webhook.
  For details, see below.
- id
- ID of the webhook. String starting with wh_.
- status
- Status of the webhook. One of the following:
  - NEW
  - CLO - Closed.
  - ERR - Error.
  - RET - Re-sent.
  Note
  Inside the data object, some webhooks have another status field that refers to a different event.
- trigger_operation_id
- ID of the operation that triggered the webhook. UUID.
- type
- Name of the webhook type.
  Note
  The name in the Client Portal is different.

Webhook Data Parameters

- activated_at
- Time that the card was activated, in Unix time.
- assigned_at
- Time that the card was assigned to a cardholder, in Unix time.
- blocked_reason
- Reason for blocking the card. One of the following:
  - blocked_reversible
  - canceled
  - compliance
  - locked_incorrect_pin
  - migrated
  - none
  - other
  - reissued
  - suspected_fraud
- card_id
- ID of the card. String starting with card_.
- card_program
- ID of the card program that the card is issued from. String starting with cardprog_.
- country_iso_alpha_2
- The country where the card is issued. Two-letter ISO 3166-1 ALPHA-2 code.
- created_at
- Time of creation of the issued card object, in Unix time.
- ewallet_contact
- Describes the wallet contact that the card is assigned to. String starting with cont_.
  address
  Address of this contact person. Required when the client issues a card to the contact. This can be an 'address' object or the ID of an address object. For more information about the fields of the 'address' object, see Create Address.
  business_details
  Describes additional information for business entities. Required when type is company.
  address
  Principal address of the business. Values for name and line1 are. See Address.
  annual_revenue
  Annual revenue of the business in US dollars. Maximum value: 100000000000000. Decimal.
  cnae_code
  Business activity code of the business, according to the Classificação Nacional de Atividades Econômicas of Brazil. Alphanumeric string. Maximum 7 characters.
  created_at
  Time of creation of the business_details object, in Unix time.
  entity_type
  Type of business entity. One of the following:
  sole_prop - Sole proprietorship.
  partnership - Partnership.
  company - Company.
  government - Government agency.
  charity - Charity.
  NPO - Non-profit organization.
  association - Unincorporated business association.
  trust - Trust.
  establishment_date
  Date that the business was established. Format: YYYY-MM-DD.
  id
  ID of the business_details object. String starting with busi_.
  industry_category
  Name of the industry that this business belongs to. Required. Alphanumeric string with no special characters.
  industry_sub_category
  Subcategory of the industry that this business belongs to.
  legal_entity_type
  Type of legal entity. Alphanumeric string.
  name
  Business name.
  registration_number
  Registration number.
  compliance_profile
  Indicates the degree to which this contact can use the wallet. One of the following:
  1 - All transactions are allowed.
  0 - The wallet is limited, and the contact must complete the identity verification process.
  -1 - The wallet is restricted and cannot be used for any transactions.
  contact_reference_id
  ID of a wallet contact, defined by the customer or end user. Must be unique. String. Cannot start with cont_.
  contact_type
  Type of contact. One of the following:
  personal - An individual customer.
  business - A business customer.
  country
  The two-letter ISO 3166-1 ALPHA-2 code for the country.
  To determine the code for a country, see List Countries.
  created_at
  Time of creation of the contact object, in Unix time.
  date_of_birth
  Date of birth of the individual. Format: YYYY-MM-DD
  email
  Email address of the contact.
  ewallet
  ID of the Rapyd Wallet that this contact is associated with. String starting with ewallet_.
  first_name
  First name of the personal contact or primary person associated with the business contact. For a personal contact type, alphabetic characters and spaces.
  gender
  Gender of the personal contact or primary person associated with the business contact. One of the following values:
  male
  female
  other
  not_applicable
  house_type
  Description of the type of residency at the contact's residence. One of the following values:
  lease - A long-term lease.
  live_with_family - The contact lives with family.
  own - The contact owns the residence.
  owner - The contact is the owner of the residence.
  month_to_month - An informal agreement, renewable each month.
  housing_project - A room in a large residence facility, such as a residence hall or senior citizens' home.
  id
  ID of the contact object. String starting with cont_.
  identification_number
  ID number as shown by the ID document.
  identification_type
  Type of the identification document associated with the contact.
  For types that are valid in the country, use List Official Identification Documents.
  issued_card_data
  Describes additional information about the business contact for a company wallet.
  preferred_name
  The name of the contact person.
  transaction_permissions
  Indicates permissions for issuing transactions. Possible values:
  allowed
  not_allowed
  role_in_company
  The role of the named person. One of the following values:
  owner - Sole proprietor or partner.
  agent - Authorized agent or attorney in fact.
  employee - Authorized employee.
  last_name
  Family name of the personal contact or primary person associated with the business contact. For a personal contact type, alphabetic characters and spaces. Required for issuing a card to a personal contact.
  marital_status
  Marital status of the personal contact or primary person associated with the business contact. One of the following values:
  married
  single
  divorced
  widowed
  cohabiting
  not_applicable
  metadata
  A JSON object defined by the client. See Metadata.
  middle_name
  Middle name of the personal contact or primary person associated with the business contact.
  mothers_name
  Name of the mother of the personal contact or primary person associated with the business contact. Alphabetic characters and spaces.
  nationality
  The citizenship of the contact. Two-letter ISO 3166-1 ALPHA-2 code for the country. To determine the code for a country, see List Countries.
  phone_number
  Phone number of the contact in E.164 format.
  second_last_name
  Second last name of the personal contact or primary person associated with the business contact.
  send_notifications
  Determines whether Rapyd sends notifications to the contact. Default is false.
  verification_status
  Result of the verification check. One of the following:
  not verified - The contact has not been submitted for the Know Your Customer checks.
  KYCd - The user has passed the Know Your Customer checks.
- id
- ID of the Issued Card object. String starting with ci_.
- metadata
- A JSON object defined by the client. See Metadata.
- public_details
- Non-private details about the card.
  bin
  Bank Identifier Number.
  last4
  Last four digits of the card.
  sub_bin
  Card program.
  expiration
  Month and year of the card expiration.
- status
- Status of the card. One of the following:
  - ACT - Active.
  - BLO - Blocked.
  - IMP - Imported in bulk, but not yet personalized.
  - INA - Inactive.

BULK_ISSUED_CARD_PERSONALIZED Webhook

{
    "id": "wh_e1904d27d76c4346a827aacda51ba54d",
    "data": {
        "id": "ci_4d7b2f6427ee74af9fbdcd2f3c8fe9e7",
        "status": "INA",
        "card_id": "card_6b1ef51b205a3e5611cec8c534f57aa1",
        "metadata": {},
        "created_at": 1655208562,
        "assigned_at": 1655208913,
        "activated_at": 0,
        "card_program": "cardprog_6174acc6a66f70309993f2d2b0fceec3",
        "blocked_reason": "none",
        "public_details": {
            "bin": "990003",
            "last4": "9006",
            "sub_bin": "10",
            "expiration": "0123"
        },
        "ewallet_contact": {
            "id": "cont_21b0ab9fc41451c976bb6907333c1e53",
            "email": "janed@rapyd.net",
            "gender": "female",
            "address": {
                "id": "address_d46ca6f3bdc76986634e0e28fe91e9ac",
                "zip": "47834001",
                "city": "Anytown",
                "name": "Jane Doe",
                "state": "NY",
                "canton": "",
                "line_1": "123 Lake Forest Drive",
                "line_2": "Apartment 4",
                "line_3": "East Neighborhood",
                "country": "US",
                "district": "",
                "metadata": {},
                "created_at": 1655207169,
                "phone_number": "+5511978789562"
            },
            "country": "US",
            "ewallet": "ewallet_05b288abcb4aba6e5579365923e30187",
            "metadata": {},
            "last_name": "Doe",
            "created_at": 1655207170,
            "first_name": "Jane",
            "house_type": "lease",
            "middle_name": "June",
            "nationality": "US",
            "contact_type": "personal",
            "mothers_name": "Jane Smith",
            "phone_number": "+5511978989562",
            "date_of_birth": "2000-11-22",
            "marital_status": "single",
            "business_details": null,
            "issued_card_data": {
                "preferred_name": "",
                "role_in_company": "",
                "transaction_permissions": ""
            },
            "second_last_name": "",
            "compliance_profile": 3,
            "send_notifications": false,
            "identification_type": "ID",
            "verification_status": "not verified",
            "identification_number": "82237738050"
        },
        "country_iso_alpha_2": "US"
    },
    "type": "BULK_ISSUED_CARD_PERSONALIZED",
    "status": "NEW",
    "created_at": 1655208913,
    "extended_timestamp": 1655208913556,
    "trigger_operation_id": "605585e7-e5a7-4476-aa6c-51768c475c91"
}

In this section:

Documentation

Bulk-Issued Card Personalized Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results