GuidesRecipesAPI ReferenceChangelog
API Reference

Create Plan

post
https://bank.sandbox.cybrid.app/api/plans

Creates a plan.

Create a plan

Plans can be created for a Bank or a Customer.

To create plan for your Bank, omit the customer_guid parameter in the request body. To create plans for your Customers, include the customer_guid parameter in the request body.

StateDescription
storingThe Platform is storing the plan details in our private store
planningThe Platform is currently building the plan
completedThe Platform has successfully completed the plan
failedThe Platform was not able to successfully complete the plan

Required scope: plans:execute

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for plan creation.

string
enum
required

The type of product the plan is for.

Allowed:
string | null

The unique identifier for the bank.

string | null

The unique identifier for the customer.

source_account
object
required

Source account

destination_account
object
required

Destination account

travel_rule_info
object | null

Travel rule information

string | null
enum

The purpose of transaction for the plan.

labels
array of strings | null

The labels associated with the plan.

labels
supporting_documents
array of objects | null

Supporting documents to attach to the plan. Only valid for remittance plans; requests that include this field on other plan types are rejected. Optional when type is remittance.

supporting_documents
Responses

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago