Objects

The object shapes referenced by the Cybrid OrganizationAPI endpoints — identical to Cybrid's own schemas.

Organization

guidstringrequired

Auto-generated unique identifier for the organization.

namestringrequired

Name provided for the organization.

created_atstring<date-time>required

ISO8601 datetime the record was created at.

updated_atstring<date-time>

ISO8601 datetime the record was last updated at.

PatchOrganization

Request body for organization modification.

namestring

Name for the organization.

Subscription

guidstringrequired

Auto-generated unique identifier for the subscription.

organization_guidstring

The organization guid for the subscription.

namestringrequired

Name provided for the subscription.

typewebhook | emailrequired

The type of subscription.

urlstring

The url for the subscription. Required when subscription_type is webhook.

signing_keystring

Subscription private signing key. Optional when subscription_type is webhook.

recipientstring

Recipient email address. Required when subscription_type is email.

deliveries_failing_sincestring<date-time>

ISO8601 datetime the deliveries started failing.

environmentstringrequired

The environment that the subscription is configured for; one of sandbox or production.

statestringrequired

The state of the subscription; one of storing, completed, or failed.

failure_codestring

The failure code of a subscription (if any)

created_atstring<date-time>

ISO8601 datetime the record was created at.

updated_atstring<date-time>

ISO8601 datetime the record was last updated at.

PostSubscription

Request body for subscription creation.

environmentsandbox | productionrequired

The environment that the subscription is configured for.

typewebhook | emailrequired

Type of the subscription.

namestringrequired

Name provided for the subscription.

urlstring

URL provided for the subscription. Required when type is webhook.

recipientstring

Recipient email address. Required when type is email.

PatchSubscription

Request body for subscription modification.

namestring

Name for the subscription.

SubscriptionList

totalintegerrequired

The total number of records available.

pageintegerrequired

The page index to retrieve.

per_pageintegerrequired

The number of entities per page to return.

objectsobject[]required

SubscriptionEvent

guidstringrequired

Auto-generated unique identifier for the subscription event.

bank_guidstring

The bank guid for which the event is received.

event_typestringrequired

The type of the subscription event. One of trade.storing, trade.pending, trade.executed, trade.cancelled, trade.completed, trade.settling, trade.failed, transfer.storing, transfer.pending, transfer.holding, transfer.reviewing, transfer.cancelling, transfer.completed, transfer.failed, identity_verification.storing, identity_verification.pending, identity_verification.reviewing, identity_verification.waiting, identity_verification.expired, identity_verification.completed, plan.storing, plan.planning, plan.completed, plan.failed, execution.storing, execution.executing, execution.completed, execution.failed, account.minimums.funding_pull.below_minimum, or account.minimums.funding_pull.near_minimum.

object_guidstringrequired

The object guid for which the event is received.

environmentstringrequired

The environment that the subscription event is configured for; one of sandbox or production.

organization_guidstringrequired

The organization guid of the subscription event.

created_atstring<date-time>required

ISO8601 datetime the record was created at.

updated_atstring<date-time>

ISO8601 datetime the record was last updated at.

SubscriptionEventList

totalintegerrequired

The total number of records available.

pageintegerrequired

The page index to retrieve.

per_pageintegerrequired

The number of entities per page to return.

objectsobject[]required

SubscriptionDelivery

guidstringrequired

Auto-generated unique identifier for the subscription delivery.

responsestring

The response of the subscription delivery.

subscription_event_guidstringrequired

The subscription event guid of the subscription delivery.

subscription_guidstringrequired

The subscription guid of the subscription delivery.

statestoring | completed | failing | failedrequired

The state of the subscription delivery.

next_attempt_atstring<date-time>

ISO8601 datetime the next attempt will be made.

attempt_countintegerrequired

The number of attempts made to deliver the event.

completed_atstring<date-time>

ISO8601 datetime the event was delivered.

failed_atstring<date-time>

ISO8601 datetime the event delivery was marked as failed.

created_atstring<date-time>

ISO8601 datetime the record was created at.

updated_atstring<date-time>

ISO8601 datetime the record was last updated at.

PostSubscriptionDelivery

Request body for subscription delivery creation.

subscription_event_guidstringrequired

The event guid .

subscription_guidstringrequired

The subscription guid.

SubscriptionDeliveryList

totalintegerrequired

The total number of records available.

pageintegerrequired

The page index to retrieve.

per_pageintegerrequired

The number of entities per page to return.

objectsobject[]required

ErrorResponse

statusintegerrequired

Status code for Http Request

error_messagestringrequired

Error message

message_codestringrequired

Message code for Error