Create Transaction

put

https://{your-gateway-url}/transactions/

Create a transaction

Body Params

method

string

enum

required

Defaults to ACH

The method of transaction. RTP transactions may take up to 30 seconds to complete based on configuration and financial institution. CRD transactions process card payments through the TSYS Sierra card network.

Allowed:

type

string

enum

required

Defaults to Debit

The type of the transaction. Available types: Credit, Debit

Allowed:

amount

int32

required

Defaults to 100

Amount of the transaction in cents. Must be positive for CRD auth_only and auth_capture transactions.

paymentDetails

object

required

Information regarding the payment method. Required fields vary by method.

standardEntryClassCode

string

Defaults to WEB

Must be specified when "method" is "ACH". This is the SEC code for the transaction. List of sec codes

externalUniqueId

string

A unique ID supplied by merchants, and used by merchant's for their own processing. This ID will be passed along with the transaction.

idempotencyKey

string

A unique ID supplied to prevent duplicate submission. If the check for this is enabled for a merchant, submitting a transaction with an idempotency key that has already been submitted, the transaction will be Held.

effectiveDate

date

Format: YYYY-MM-DD. The date to schedule the payment for. This must be a date in the future. If not supplied, it will default to current date (i.e. next processing time) and the applied effective date will be returned in the response.

crdAction

string

enum

Defaults to auth_capture

Optional for CRD transactions. Determines the card transaction flow. Defaults to auth_capture if not specified.

auth_only — Authorizes the card but does not capture. The authorization must be captured separately. Authorizations expire after 7 days.
auth_capture — Authorizes and captures the card in a single request. The transaction is included in the next batch settlement.

Allowed:

requestAvs

boolean

Defaults to true

Optional for CRD transactions. Whether to request AVS (Address Verification Service) verification. Defaults to true.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400

403403