Payment overview
The transaction banking payment feature of the Pismo platform provides functionalities that help you perform different payment transactions such as posting credit or debit payments, force transfer payments, and multi-leg payments. Key functions include:
- Post payment: Use this feature to post both credit and debit transactions to an account. Additionally, you can initiate force transfer payments.
- Post multi-leg payment: Execute multiple payment transactions simultaneously. Rather than submitting individual payment requests, you can consolidate different payment types (credit, debit, or a combination of both) into a single request for enhanced efficiency and convenience.
Post payment
The Pismo platform features a Post payment API that enables transaction banking account holders to transfer funds, and conduct cash-in and cash-out transactions. This API leverages many features of the Core payments API, but is particularly tailored for transaction banking clients..
Post payment enables the posting of debits and credits to an account and facilitating fund transfers between them. Follow the guidelines below to use the API for posting credits, debits, earmark payments, or conducting fund transfers. For details about how the Payments API works in general, refer to Payments and transfers.
Post credit payments
When initiating credit payments, ensure that you include a credit
object containing a valid processing_code
and an external_account_id
. These attributes identify the target account and the financial transaction type. The following table describes these fields:
Field name | Description |
---|---|
external_account_id | Identifies the external ID of the account to which the credit payment is posted. This ID is different from the one provided to you by Pismo. |
processing_code | Defines a financial operation type and how the platform handles it. For details about processing codes, refer to processing codes and transaction types. |
Post debit payments
Likewise, for debit payments, you must provide values for processing_code
and external_account_id
within the debit
object. Note that if the debit object includes an earmark_id
value, the debit amount is deducted directly from the earmark balance. The earmark_id
indicates the ID the earmarked balance from which the amount is withdrawn, the Earmark ID is generated by the Create earmark endpoint.
Execute fund transfer
To execute fund transfers, include both credit and debit objects. If you specify an earmark_id
value within the debit
object, the transferred amount is deducted directly from the earmark balance.
Execute force transfers
To execute force transfers, include both a credit
and a debit
object, and set the force_post
field to true
. Note that force transfers from an earmark balance are not supported.
If an account has a status that prevents force operations, the transfer will fail. For more information, refer to Manage account statuses.
Reasons that restrict force credit or debit operations are:
Reason ID type | Behavior |
---|---|
ANY | Any transaction will be posted without restrictions. |
MANUAL | Only force transactions are allowed. |
CREDIT ONLY | Only credits and force transactions are allowed. |
DEBIT ONLY | Only debits and force transactions are allowed. |
CREDIT ONLY - NO FORCE DEBIT ALLOWED | No force debit transactions allowed. |
DEBIT ONLY - NO FORCE CREDIT ALLOWED | No force credit transactions allowed. |
ANY - NO FORCE ALLOWED | All transactions allowed, except force transactions. |
MANUAL - NO FORCE ALLOWED | Manual add or update transactions are allowed, except force transactions. |
To get a list of available reasons for a specific account status, use the List account status reasons endpoint.
For sample payloads for each of the aforementioned payment types, refer to the examples provided in Post payment endpoint.
Updated 8 days ago