API Reference
  1. Treasury Solutions
  2. Transaction

Create transaction

post
https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer///transaction

Create a transaction to move funds using BOOK, ACH, CHECK, WIRE, or CARD methods. Supports collecting funds into a Passport account (credits) and sending funds out (debits).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the customer. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

Unique identifier of the customer. The value corresponds to the identifier type specified in parentIdType.

Body Params

Transaction details including source, destination, amount, and method.

Request body for creating a fund transfer transaction. Supports collecting funds into a Passport account (credits) and sending funds out (debits).

string
required

The dollar value of the transaction. Must be greater than zero.

string
enum
required

Payment method. BOOK: internal account-to-account transfer. ACH: bank transfer via Automated Clearing House. CHECK: paper check deposit or send. WIRE: wire transfer for high-value or time-sensitive payments. CARD: debit/credit card collection.

Allowed:
string
required

Purpose of the transaction. All characters are allowed.

string
enum

Transaction type. REGULAR: standard fund transfer. REFUND: reversal of a prior transaction. EXTERNAL: external check transaction originated outside the platform.

Allowed:
string

Program manager-assigned external reference identifier for the transaction.

source
object

The entity to be debited. For collect transactions, this is the external account, card, or contact. For send transactions, this is the Passport account.

destination
object

The entity to be credited. For collect transactions, this is the Passport account. For send transactions, this is the external account, address, or contact.

boolean

When true, allows creation of a transaction with the same amount, source, and destination as an existing one.

string

Additional comment or note for the transaction.

tags
array of strings

Labels or tags assigned to the transaction.

tags
metaData
object

Custom key-value metadata for the transaction.

boolean

When true, the BOOK debit is ledgered instantly without waiting for standard clearance.

string

Date on which the transaction should be processed (MM/DD/YYYY). If omitted, defaults to the current business day.

boolean

For CARD method. Set to true to automatically capture the authorized amount.

amountDetails
object

Detailed breakdown of the transaction amount.

processingDetail
object

Additional processing instructions specific to the transaction method.

linkedDocument
array of objects

Documents linked to the transaction (e.g., check images for CHECK method).

linkedDocument
funding
object

Funding configuration for the transaction.

Responses

400

The request could not be processed. Check for missing required fields, invalid values, or incorrect data formats.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?