Recipients

In the Kredete API, a Recipient represents an individual or entity designated to receive funds through ACH or Wire transfers. Managing recipients efficiently is crucial for seamless and secure transactions.

Recipient Object Structure

The Recipient object encompasses essential details required to process a transfer. Below is the structure of the Recipient object:

{
  "id": "recipient_xyz123",
  "created_at": "ISO-8601",
  "updated_at": "ISO-8601",
  "status": "active",
  "name": "John Doe",
  "email": "[email protected]",
  "phone_number": "+1234567890",
  "account_number": "123456789012",
  "routing_number": "021000021",
  "account_type": "checking",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "NY",
    "postal_code": "12345",
    "country": "USA"
  },
  "metadata": {}
}

Attributes

• id (string): Unique identifier for the recipient in Kredete’s system.
• created_at (string): Timestamp when the recipient was created (ISO 8601 format).
• updated_at (string): Timestamp of the last update to the recipient (ISO 8601 format).
• status (string): Current status of the recipient (e.g., active, inactive, deleted).
• name (string): Full name of the recipient.
• email (string): Email address of the recipient.
• phone_number (string): Contact phone number of the recipient.
• account_number (string): The recipient's bank account number.
• routing_number (string): The bank's routing number associated with the account.
• account_type (string): Type of bank account (checking or savings).
• address (object): Physical address of the recipient, including:
  • street (string): Street address.
  • city (string): City.
  • state (string): State or province.
  • postal_code (string): ZIP or postal code.
  • country (string): Country.
• metadata (object): A set of key-value pairs for storing additional information about the recipient.

Statuses and Lifecycle

Recipients in the Kredete system can have various statuses that reflect their current state:

• active: The recipient is eligible to receive transfers.
• inactive: The recipient is temporarily ineligible to receive transfers.
• deleted: The recipient has been removed and cannot receive transfers.

Managing Recipients

To facilitate efficient fund transfers, it's essential to manage recipients effectively:

Creating a Recipient

Provide the necessary details, including name, contact information, bank account details, and address.

Updating a Recipient

Modify recipient information as needed to ensure accuracy.

Deleting a Recipient

Remove a recipient when they are no longer needed.

Example: Creating a Recipient

To create a new recipient, send a POST request to the /apis/recipients endpoint with the required information:

POST /apis/recipients
Content-Type: application/json

{
  "name": "John Doe",
  "email": "[email protected]",
  "phone_number": "+1234567890",
  "account_number": "123456789012",
  "routing_number": "021000021",
  "account_type": "checking",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "NY",
    "postal_code": "12345",
    "country": "USA"
  },
  "metadata": {
    "customer_id": "cust_abc123"
  }
}

Response

A successful response will include the recipient's unique identifier and status:

{
  "id": "recipient_xyz123",
  "status": "active",
  "created_at": "2024-12-22T00:00:00Z",
  "updated_at": "2024-12-22T00:00:00Z"
}

Conclusion

Managing recipients is a fundamental aspect of utilizing the Kredete API for ACH and Wire transfers. By maintaining accurate and up-to-date recipient information, you ensure the efficiency and security of your financial transactions.