API Reference
Bancorp Release
API Reference

Create Transaction

post
https://{FQDN}:{PORT}/v1/clients//transactions

Creates a Transaction.

In circumstances where you fail to receive a transactionID from us, you can do a retrieve via referenceID. (Allowed only up to 24 hours after original request)

Path Params
string
required

22-character ClientID. Ask Support if you need to specify a SubClientID.

Query Params
string
length between 0 and 0

Note the query string, ?authorize, will create an authorization only. For pull payments. To settle the transaction, you must call Capture Transaction.

Request to enable Auth & Capture at Support

Body Params
string
required

1-15 character unique referenceID. Used for Retrieve via ReferenceID in case of an HTTP timeout, or any scenario where you fail to get a response body.

string

Optional Corresponding Transaction ID

Incompatible with corresponding object.

corresponding
object

Corresponding Transaction Information

For a push transaction, this would be the corresponding pull transaction.
For a pull transaction, this would be the corresponding push transaction.

Optional. Incompatible with correspondingID.

string
required

4-character Transaction Type

push and pull are the only valid values. This is used to verify that your Source and Destination Accounts are valid

accounts
object
required

Accounts

string

ISO 4217 3-Digit Currency Code.

Optional. Default is 840

string
required

See how to properly format an amount.

string

OFAC Value from Query OFAC

Optional

string

22-character avsID
Received in the response of QueryCard + AVS/ANI.

Optional

string

Code describing the purpose of payment

Conditional. May be required, dependent on the country of the issuing BIN

string

1-32 character Memo

Optional. For ACH transactions, the first 10 characters of the memo will be used as the ACH entry description.

To set convenience fees on a per transaction basis, refer to the convenience fee guide.

string

ACH Options

  • R RTP
  • N Next Day
  • S Same Day

Required for RTP or ACH, else optional.

Request to enable ACH or RTP at Support

string

Three Options

  • CCD Corporate Credit or Debit
  • PPD Prearranged Payment and Deposit
  • WEB Website, App, or Mobile Initiated Entry

Required for ACH, else optional.

pullOptions
object

Additional Pull Options

Optional

softDescriptor
object

Soft Descriptor.

Card Network Mandates for Soft Descriptor: To avoid fines or to avoid declines, when providing zipCode and state, please ensure they match i.e. zipCode must correspond to the state values.

Optional

location
object

Location of Origination of Transaction

Optional

Responses

Updated about 2 months ago

Language
Credentials
Bearer
JWT
URL
Response 
 Choose an example:
application/json
Updated about 2 months ago