Transfer funds

Note: Enhanced features and improvements are available in the Payment methods API, the new application interface for non-card network authorizations. This Transfer funds endpoint is still supported, but all new feature developments will be available only in the Payment methods API. For more information, contact your Pismo representative.


Transfer funds between a source (from) and destination (to).

The to and from objects contain information about one of the following payment methods:

  1. account - Platform merchant or customer account
  2. card - Credit card stored in a digital wallet, known as a card on file
  3. custom_info - Custom payment information, usually about an external account
  4. merchant - Platform merchant

Transfers

You can use this endpoint to make the following types of transfers:

  • Pismo platform account to Pismo platform account (P2P)
  • Pismo platform account to merchant account (P2M)
  • Card to platform account (P2P with card)
  • Pismo platform account to merchant account with card (P2M with card)
  • Merchant account to merchant account (M2M)
  • Cashin
  • Cashin with card
  • Cashout
  • Cashout with card
  • Payment, which requires token (code) from creating payment request

See the Examples drop-down menu for sample payloads for each of these transfer types. See the Make transfer guide for more details on these transfer type use cases.

This endpoint generates an Authorization created event.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
from
array
required

Source method to transfer funds. You must provide one item in this array.

from*
to
array
required

Destination method to transfer funds. You must provide one item in this array.

to*
string
length between 36 and 50

Unique tracking ID of the transaction. If you don't provide one, the Pismo platform generates it randomly.

string

Payment entry mode.

location
object

Request latitude and longitude object.

metadata
object

Any key-value object to add custom information.

string

Validation token used for payment-requests transfers.

date-time

Value date (effective date) of the payment in UTC-0 (RFC3339) format. Payments can be backdated but future dates are not allowed. example: '2020-01-02T15:14:00.218Z'

string

Optional text that describes the created transaction. The platform supports only letters and numbers in this field and removes any special characters or emojis.

integer

Maximum time (in seconds) a payment can take. Optional field forwarded to acquirers.

integer
deprecated

ID of POS device initiating request. This field is DEPRECATED - the ID should now be passed in the Merchant Payment Method. Passing it here will cause it to not be stored, which could lead to cancellations referencing the wrong merchant.

authorization_validations
object

Object containing the authorization validation data.

Headers
string
required
length between 39 and 39

Unique Org ID.

string

The correlation identifier field is used to link related API requests and events. For example, if a user makes an authorization request with 10 installments, this generates 1 authorization event and 10 transaction events all containing the same correlation ID. The x-cid can help the Pismo engineering team track everything related to a call.

number

Optional account ID. For P2P, this should be the from account ID.

string

Any value here results in an event not being generated in the customer timeline.

string

If true, the HTTP response status code returned is 208 (already reported) and not 409 (conflict)

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json