v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Schedules

Get schedule

Get account schedule by schedule ID.

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

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

Challenge result

account_idinteger

Account ID

status'PENDING' | 'PROCESSING' | 'CANCELLED' | 'SETTLED' | 'PROCESSED'

PENDING: Charge is scheduled and waiting for the cycle to close. PROCESSING: Cycle closing process has started and is awaiting completion. CANCELLED: Charge canceled due to link cancellation. SETTLED: Amount is zero and/or minimum_spend_to_charge has not been reached. PROCESSED: Charge was posted on the statement."

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

metadatastring

Any data object with key/value pairs. No limit on length.

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 for the debit transaction.

If split_transaction is false (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and processing_code is the processing code for that transaction.

If split_transaction is true, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, processing_code is the processsing code for the debit transaction, and second_processing_code is the processing code for the credit transaction.

amountnumber double

Fee amount.

currency_codestring

ISO 4217 3-letter currency code, For example, 986 = Brazilian real and 840 = US dollar.

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": "Challenge expired",
  "schedule_details": {
    "type": "authentication",
    "day_type": "CALENDAR_DAY",
    "start_date": "2023-01-02T07:00:00.000Z",
    "end_date": "2023-03-30T12:26:41",
    "retries": {
      "interval_recurrence": 5,
      "number_of_attempts": 5
    },
    "statement": {
      "id": 1234455
    }
  },
  "account_id": 6912345,
  "status": "PENDING",
  "created_at": "2024-09-12T16:46:16.43663522",
  "metadata": "{ \"key\": \"value\"}",
  "pismo_metadata": {
    "any-key": "any-value"
  },
  "processing_code": "99066",
  "processing_codes": {
    "credit": "219803",
    "debit": "219803"
  },
  "amount": 215,
  "currency_code": "840",
  "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": 215,
      "metadata": "{ \"key\": \"value\"}",
      "to": {
        "account_id": 6912345,
        "processing_code": "99066"
      },
      "from": {
        "account_id": 6912345,
        "processing_code": "99066"
      }
    }
  ]
}