Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Payments (Pismo account ID)

Post float cash-in (Pismo account ID)

Enable users to submit float cash-in payments to the Pismo platform. It supports posting credits to an account, as well as facilitating fund transfers between accounts.

To post a credit, you must provide a valid processing_code for the credit operation and the recipient's external_account_id.

See the <b>Examples</b> drop-down menu for a sample payload.

For more information about payments operations, see Corporate Banking Launch Reference.

<b>NOTES</b>:

  • This endpoint requires an account-specific access token. Getting an account token requires you to call the Get OpenID access token endpoint with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Each payment created generates the following events:

See Data and reporting for more information about events and setting up event notifications.

post/corporate/v1/corporate-float-cashin

Request body

external_account_idstring required

External ID of the account to which the transaction is posted.

currencystring required

3-letter, ISO-4217 standard alphabetic code for the currency used in the total and float amounts.

total_amountnumber required

Transaction amount

float_amountnumber float required

Part of the total amount that is deferred to settle on the settlement_date. If it is equal to or greater than total_amount, a bad request error is returned.

tracking_idstring required

Customer created tracking ID. Must consist of alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), and colons (:), with a length from 1 to 128. The Pismo platform uses this field to implement idempotency and prevent duplicates.

settlement_datestring date required

Future date on which the float_amount is settled. Corresponds to the cycle closing date relative to the payment date.<br> <b>Notes</b>:

  • The settlement date is in ISO 8601 format.
  • It's similar to the business_date attribute for regular payment operations.
processing_codestring

Processing code for posting credit transactions. The code must have a credit balance impact. You can retrieve a list of the organization processing codes using List processing codes.

descriptionstring

A brief description that appears on the bank statement to help identify a particular transaction.

metadataFloatMetadata

Key-value pairs containing data intended for storage in the Pismo system.<br> <b>NOTES</b>:

  • The metadata includes a corporate_metadata object with the following subfields:
    • credit_external_account_id
    • authorization_type
    • business_date
    • float_amount
    • settlement_date
  • The corporate_metadata field must be an object. A type mismatch results in an error as mapped in the responses section.<br>

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.

Example request

{
  "external_account_id": "289",
  "currency": "USD",
  "total_amount": 86753.09,
  "float_amount": 300.52,
  "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
  "settlement_date": "2023-03-09",
  "processing_code": "220035",
  "description": "ACME Inc. - Invoice 2938"
}

Response

Created

tracking_idstring

Customer created tracking ID. Must consist of alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), and colons (:), with a length from 1 to 128. The Pismo platform uses this field to implement idempotency and prevent duplicates.

status'CREATED' | 'UNSETTLED' | 'SETTLED' | 'FAILED'

Status of the deferred payment

Example response

{
  "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
  "status": "CREATED"
}