Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Originator

Update an Originator

Update an Originator's parameters.

patch/v0/originators/{originator_id}

Path parameters

originator_idstring required

The ID of the originator to be retrieved.

Headers

Idempotency-Keystring

Idempotency key

Request body

company_namestring
metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example request

{
  "ach": {
    "allowed_sec_codes": [
      "WEB"
    ],
    "nested_third_parties": [
      "entity_xyz123"
    ]
  }
}

Response

Successful response

idstring

The ID of the Originator.

account_idstring

The ID of the Account object.

entity_idstring

The ID of your entity.

status'pending' | 'active' | 'inactive' | 'rejected' | 'canceled' | 'suspended'

Originator Status

company_namestring
company_idstring

ACH Company Id

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "originator_xyz123",
  "account_id": "account_xyz123",
  "entity_id": "entity_xyz123",
  "status": "active",
  "company_name": "Acme Inc.",
  "ach": {
    "allowed_sec_codes": [
      "WEB"
    ],
    "nested_third_parties": [
      "entity_xyz123"
    ]
  },
  "created_at": "2022-06-27T11:22:33Z",
  "updated_at": "2022-06-27T11:22:33Z"
}