Perform cash-out

post

https://sandbox.pismolabs.io/integrated-payments/v1/transfers/cashout

Perform an external transfer, using a provider to process the outgoing account resources. This endpoint generates the following events:

Transfer-out created - Cash-out event.
Financial transaction status updated - Cash out status change. Status becomes SETTLED after clearing and accounts have been credited and debited.
Integrated payments financial reconciliation- This event is generated after the transaction has been cleared and accounts debited or credited.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request Body

account_id

integer

required

Pismo Platform client ID.

amount

number

required

Dot-separated transfer amount in decimals.

currency_code

string

ISO 4217 currency code. Can be either numeric or alphabetic.

processing_code

string

required

Transfer processing code. Used to identify the type of transfer.

creditor

object

Headers

Authorization

string

required

Account token. Getting an account token requires you call the Server login endpoint with an account ID. Tokens can expire quickly, which can result in an Unauthorized message. Enter this field under AUTHENTICATION.

x-idempotency-key

string

required

Unique identifier (UUID) to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

x-skip-reconciliation

boolean

If true, the reconciliation process is skipped and the Integrated payments financial reconciliation event is not generated. Default is false.
The financial reconciliation process compares the transaction made on Pismo with the same transaction made on the provider side (i.e., BTG or Celcoin).

X-Signature

string

This header is designed for clients working with a third‑party provider that requires certain transactions to include a certified digital signature for added security. It is optional and should be used only if your provider requires signature validation. When included, our APIs forward the header to the provider, which verifies the signature and approves or rejects the transaction based on its authenticity.

Responses

Perform cash-out

Changelog

Support

Pismo is here to help

202Response Body

400Bad Request

403Forbidden

409Conflict

500Internal Server Error