PIpismo
Interest engine

Withdraw money

Withdraw amount from an account.

This endpoint generates the following events.

For more information, refer to the Interest-bearing accounts guide.

post/v1/interest/withdrawal

Request

  • Base URL
    https://sandbox.pismolabs.io/interest-engine
  • URL
    https://sandbox.pismolabs.io/interest-engine/v1/interest/withdrawal
  • Auth
    HTTP bearer

Headers

content-typestring required

Content type

authorizationstring required

Authorization

Request body

tracking_idstring UUID required

Tracking ID for the operation to ensure idempotence. Must be an alphanumeric UUID with the alphabetical characters in lowercase.

account_idstring number required

Account ID. Must be between 1 and 64.

amountnumber double required

Amount to be deposited

withdrawal_datestring date required

Deposit date. Format = YYYY-MM-DD.

metadataMetadata

Free-form key-value metadata. The serialized JSON must not exceed 4096 bytes.

external_account_idstring

External account ID managed by the requester

Example request

{
  "tracking_id": "41dee125-0876-4505-80cd-947cb6049789",
  "account_id": "123000",
  "amount": 5365.5,
  "withdrawal_date": "2024-01-15"
}

Response

OK

tracking_idstring UUID required

Tracking ID for the operation to ensure idempotence. Must be an alphanumeric UUID with the alphabetical characters in lowercase.

external_account_idstring

External account ID managed by the requester

Example response

{
  "tracking_id": "07d84f79-3027-47bd-b628-65528ccc8fb2",
  "external_account_id": "4141"
}

Changes

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