PIpismo
Schedules

Get schedule

Get account schedule by schedule ID.

get/v1/accounts/{accountId}/schedules/{scheduleId}

Request

  • Base URL
    https://sandbox.pismolabs.io/scheduler-payments
  • URL
    https://sandbox.pismolabs.io/scheduler-payments/v1/accounts/{accountId}/schedules/{scheduleId}
  • Auth
    HTTP bearer

Response

Request was processed successfully, existing schedule with the corresponding ID returned.

schedule_idstring

Schedule ID (idempotency field for this operation)

schedule_kind'SINGLE' | 'MULTIPLE' | 'PRE'

Schedule type

descriptionstring

Optional text that describes the operation

account_idinteger

Account ID

status'CREATED' | 'IN_PROGRESS' | 'CANCELED' | 'COMPLETED'

Schedule status

created_atstring date-time

Date of schedule creation in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.

metadataMetadata

This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. The Pismo platform does not perform any validation or processing on this field.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

pismo_metadataPismoMetadata

Any key-value object with custom information that must be passed forward in the Pismo authorization flow. Used for internal purposes only.

processing_codestring

Processing code that identifies the credit or debit operation

amountnumber float

Credit or debit amount

currency_codestring

Three-letter currency code of the operation in ISO 4217.

strategy'OVERDRAFT_SWEEP' | 'SWEEP'

If the strategy field is not specified, you must provide the amount field for each transfer in the transfers array. The following strategy types determine the transfer amounts when a strategy is specified.

  • SWEEP: Transfers the entire balance from the child account to the parent account. The terms "parent" and "child" refer to account roles, but no relationship validation is performed.

    Child → Parent

  • OVERDRAFT_SWEEEP: Follows the same logic as SWEEP, except when a child account is negative, in which case the main account sends enough money to zero out the child account.

    Parent → Child

Example response

{
  "schedule_id": "eec3df75-629d-43dc-8eb7-e3b186188341",
  "schedule_kind": "SINGLE",
  "description": "Custom purchase",
  "schedule_details": {
    "type": "RECURRING",
    "interval": "DAILY",
    "day_type": "CALENDAR_DAY",
    "start_date": "2023-01-02T07:00:00.000Z",
    "end_date": "2023-01-02T07:00:00.000Z",
    "retries": {
      "interval_recurrence": 5,
      "number_of_attempts": 5
    },
    "statement": {
      "id": 1234455
    }
  },
  "account_id": 8675309,
  "status": "COMPLETED",
  "created_at": "2023-01-02T07:35:05.125Z",
  "metadata": {
    "any-key": "any-value"
  },
  "pismo_metadata": {
    "any-key": "any-value"
  },
  "processing_code": "219803",
  "processing_codes": {
    "credit": "219803",
    "debit": "219803"
  },
  "amount": 100.23,
  "currency_code": "BRL",
  "restrictions": {
    "minimum_daily_available": 100.23,
    "minimum_monthly_average_available": 100.23,
    "minimum_days_account_inactivity": 5
  },
  "strategy": "SWEEP",
  "transfers": [
    {
      "description": "Transfer to savings account",
      "amount": 100.23,
      "metadata": {
        "any-key": "any-value"
      },
      "to": {
        "account_id": 8675309,
        "processing_code": "219803"
      },
      "from": {
        "account_id": 8675309,
        "processing_code": "219803"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.