Withdrawal Paylet

What is a Withdrawal Transaction?

This is a Transaction that transfers funds from a Managed Instrument back to an External Instrument, both owned by the same Corporate Identity. In the same way that funds are deposited from an External Instrument via bank transfer, the Withdraw Transaction returns funds to an External Instrument via the same mechanism (in reverse).

Refer to the Withdrawals Swagger documentation for the complete list of APIs that may be invoked in relation to the withdrawal transaction.

Withdrawal Paylet API

URL Method Description
/withdrawals/get POST Retrieves a list of withdrawal instances that have occurred in the programme.
/withdrawals/{id}/get POST Retrieves details of a specified Withdrawal transaction.
/withdrawals/_/create POST Creates a Withdrawal transaction using the specified source (e.g. a Managed account) and a destination (e.g. an External Account) with configuration as specified in the Withdrawal Profile
/withdrawals/profiles/get POST Retrieve a list of Withdrawal Profiles for the programme
/withdrawals/profiles/{id}/get POST Retrieve details of the Withdrawal profile specified in the request.

Withdrawal Instance Attributes

Attribute Description
Id The ID of the Withdrawal transaction
Programme id The Programme within which the Withdrawal transaction is being executed
Profile id The ID of the Profile used to configure the Withdrawal transaction
State The current state of the Withdrawal transaction. It can be one of: Initialised, Completed or Failed
Timestamp The date and time the Withdrawal was initiated
Withdrawal currency The currency of the Withdrawal transaction
Withdrawal amount The value of the Withdrawal transaction. Note that this is currently scaled to the lowest denomination of the currency e.g. to specify a withdrawal of 10 Euro, a value of 1000 would need to be entered.
Source The managed instrument details from where the funds will be taken
Destinanation The destination instrument to which the funds will be deposited
Failure Reason Provides details in case of errors during a Withdrawal transaction