Payments (Pismo account ID)

Get scheduled payment (Pismo account ID)

Get a scheduled payment by its ID.

get/cash-management/v2/scheduled-payments/{scheduledPaymentId}

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/cash-management/v2/scheduled-payments/{scheduledPaymentId}
  • Auth
    none declared

Path parameters

scheduledPaymentIdstring required

Scheduled payment ID

Response

Get scheduled payment response

idstring

ID used to reference the scheduled payment for subsequent operations.

statusstring

Status of scheduled payment

Example response

{
  "id": "d2644122-251b-41fa-b5b5-54cfad097afb",
  "status": "ACTIVE",
  "payment": {
    "amount": 215,
    "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
    "soft_descriptor": "ACME Inc. - Invoice 2938",
    "credit": {
      "external_account_id": "289",
      "processing_code": "220035",
      "soft_descriptor": "ACME Inc. - Invoice 2938",
      "metadata": {
        "my-id": 2932
      }
    },
    "debit": {
      "external_account_id": "289",
      "processing_code": "220037",
      "earmark_id": "dadaab22-6e28-4746-8440-0caa030f0f3f",
      "soft_descriptor": "ACME Inc. - Invoice 2938",
      "metadata": {
        "my-id": 2932
      }
    },
    "metadata": {
      "my-id": 2932
    },
    "validation_rules": {
      "ACCOUNT_STATUS": {
        "override": false
      },
      "LEDGER": {
        "force": false
      },
      "FLEX_CONTROLS": {
        "override": true
      },
      "RATES": {
        "override": true
      }
    },
    "payment_datetime": "2023-03-10T19:05:56.743Z",
    "business_date": "2023-03-09",
    "channel": "GDP",
    "schedule_datetime": "2020-08-13T13:49:03.000Z"
  }
}

Changes

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