AchTransactions

Payment (Debit)

Creates an ACH transaction in which funds are transferred from the customer to the merchant. This is used in regular sales transactions.

SecurityBearer or Bearer or Bearer or Bearer

Request

Request Body schema: application/json

paymentProcessorId required	string <uuid> ACHQ payment processor Id
paymentMethodId	string or null <uuid> Customer payment method ID
customerId	string or null <uuid> Customer id
amount required	number <double> Payment amount
isFasterProcessing	boolean Is same day processing enabled
routingNumber	string or null Routing number
accountNumber	string or null Account number
taxId	string or null Tax Id
accountHolderType	integer <int32> (AccountHolderType) Account holder type Possible values: 1 - Business: Business 2 - Personal: Personal Enum: 1 2
accountType	integer <int32> (AccountType) Account type Possible values: 1 - Checking: Checking 2 - Savings: Savings Enum: 1 2
	object (PaymentGateway.Contracts.Transactions.AddressDto) A commonly used address structure. Not all the fields are used in Tsys, but, generally ought to be provided.
	object (PaymentGateway.Contracts.Transactions.AddressDto) A commonly used address structure. Not all the fields are used in Tsys, but, generally ought to be provided.
	object (PaymentGateway.Contracts.Transactions.ContactInfoDto) This group contains fields regarding a customer's contact details such as email id, phone no. etc.
secCode required	integer <int32> (AchSECCode) Standard Entry Class constant that denotes the way a customer authorized a payment. Possible values: 1 - Web: Internet-Initiated/Mobile Entries. Default value. 2 - PPD: Prearranged Payment and Deposit Entries. 3 - CCD: Corporate Credit or Debit. 4 - Telephone: Telephone-Initiated Entries. Enum: 1 2 3 4

Responses

200

Success

400

Bad Request

404

Not Found

500

Server Error

post/pay-api/v1/transactions/ach/payment

Request samples

Payload
curl

application/json

{"paymentProcessorId": "5ca6b82c-7ba4-46c8-a124-676eeb956536",
"paymentMethodId": null,
"customerId": null,
"amount": 123.45,
"isFasterProcessing": true,
"routingNumber": "123123123",
"accountNumber": "222222222",
"taxId": null,
"accountHolderType": 1,
"accountType": 1,
"billingAddress": {"city": "Phoenix",
"countryId": 1,
"line1": null,
"line2": null,
"postalCode": "12345",
"stateName": null,
"stateId": 1
},
"shippingAddress": {"city": "Phoenix",
"countryId": 1,
"line1": null,
"line2": null,
"postalCode": "12345",
"stateName": null,
"stateId": 1
},
"contactInfo": {"firstName": "John",
"lastName": "Smith",
"companyName": "Aurora",
"email": "example@example.com",
"mobileNumber": null,
"smsNotification": null
},
"secCode": 0
}

Response samples

application/json

Valid parameters. Approved

{"processedAmount": 0,
"transactionId": "106ca61c-4ffb-4af8-92f0-77f4867655d2",
"typeId": 11,
"type": "AchDebit",
"statusId": 21,
"status": "Scheduled",
"responseDescription": "Command Successful. Approved.",
"responseCode": "000"
}

Payment (Credit)

Creates an ACH transaction in which funds are transferred from the merchant to the customer. This is used in credit operations, such as payouts or refunds without reference.

SecurityBearer or Bearer or Bearer or Bearer

Request

Request Body schema: application/json

paymentProcessorId required	string <uuid> ACHQ payment processor Id
paymentMethodId	string or null <uuid> Customer payment method ID
customerId	string or null <uuid> Customer id
amount required	number <double> Payment amount
isFasterProcessing	boolean Is same day processing enabled
routingNumber	string or null Routing number
accountNumber	string or null Account number
taxId	string or null Tax Id
accountHolderType	integer <int32> (AccountHolderType) Account holder type Possible values: 1 - Business: Business 2 - Personal: Personal Enum: 1 2
accountType	integer <int32> (AccountType) Account type Possible values: 1 - Checking: Checking 2 - Savings: Savings Enum: 1 2
	object (PaymentGateway.Contracts.Transactions.AddressDto) A commonly used address structure. Not all the fields are used in Tsys, but, generally ought to be provided.
	object (PaymentGateway.Contracts.Transactions.AddressDto) A commonly used address structure. Not all the fields are used in Tsys, but, generally ought to be provided.
	object (PaymentGateway.Contracts.Transactions.ContactInfoDto) This group contains fields regarding a customer's contact details such as email id, phone no. etc.
secCode required	integer <int32> (AchSECCode) Standard Entry Class constant that denotes the way a customer authorized a payment. Possible values: 1 - Web: Internet-Initiated/Mobile Entries. Default value. 2 - PPD: Prearranged Payment and Deposit Entries. 3 - CCD: Corporate Credit or Debit. 4 - Telephone: Telephone-Initiated Entries. Enum: 1 2 3 4

Responses

200

Success

400

Bad Request

404

Not Found

500

Server Error

post/pay-api/v1/transactions/ach/payment/credit

Request samples

Payload
curl

application/json

{"paymentProcessorId": "00ed1442-33bf-43dc-ac94-b4be33a237ba",
"paymentMethodId": null,
"customerId": null,
"amount": 123.45,
"isFasterProcessing": true,
"routingNumber": "123123123",
"accountNumber": "222222222",
"taxId": null,
"accountHolderType": 1,
"accountType": 1,
"billingAddress": {"city": "Phoenix",
"countryId": 1,
"line1": null,
"line2": null,
"postalCode": "12345",
"stateName": null,
"stateId": 1
},
"shippingAddress": {"city": "Phoenix",
"countryId": 1,
"line1": null,
"line2": null,
"postalCode": "12345",
"stateName": null,
"stateId": 1
},
"contactInfo": {"firstName": "John",
"lastName": "Smith",
"companyName": "Aurora",
"email": "example@example.com",
"mobileNumber": null,
"smsNotification": null
},
"secCode": 0
}

Response samples

application/json

Valid parameters. Approved

{"processedAmount": 0,
"transactionId": "430d4929-224e-4e0c-8d38-50ab6fea0e8a",
"typeId": 12,
"type": "AchRefund",
"statusId": 23,
"status": "ChargedBack",
"responseDescription": "Command Successful. Approved.",
"responseCode": "000"
}

Void

SecurityBearer or Bearer or Bearer or Bearer

Request

path Parameters

required

string <uuid>

Responses

200

Success

400

Bad Request

404

Not Found

500

Server Error

post/pay-api/v1/transactions/ach/{id}/void

Request samples

curl

Response samples

application/json

Valid parameters. Approved

{"processedAmount": 0,
"transactionId": "1423e1b7-9a97-4f85-b436-60c2fc237e59",
"typeId": 15,
"type": "AchDebit",
"statusId": 22,
"status": "Cancelled",
"responseDescription": "Command Successful. Approved.",
"responseCode": "000"
}

Refund

SecurityBearer or Bearer or Bearer or Bearer

Request

path Parameters

required

string <uuid>

Responses

200

Success

400

Bad Request

404

Not Found

500

Server Error

post/pay-api/v1/transactions/ach/{id}/refund

Request samples

curl

Response samples

application/json

Valid parameters. Approved

{"processedAmount": 0,
"transactionId": "1216c17f-e364-483e-8d45-05b3a7888d3b",
"typeId": 12,
"type": "AchRefund",
"statusId": 23,
"status": "ChargedBack",
"responseDescription": "Command Successful. Approved.",
"responseCode": "000"
}

Hold

SecurityBearer or Bearer or Bearer or Bearer

Request

path Parameters

required

string <uuid>

Responses

200

Success

400

Bad Request

404

Not Found

500

Server Error

post/pay-api/v1/transactions/ach/{id}/hold

Request samples

curl

Response samples

application/json

{"transactionId": "05345e3c-f12d-4768-8fb6-e662b1cb114e",
"typeId": 13,
"type": "AchHold",
"statusId": 26,
"status": "Held",
"responseDescription": null,
"responseCode": null
}

Remove hold

SecurityBearer or Bearer or Bearer or Bearer

Request

path Parameters

required

string <uuid>

Responses

200

Success

400

Bad Request

404

Not Found

500

Server Error

post/pay-api/v1/transactions/ach/{id}/unhold

Request samples

curl

Response samples

application/json

{"transactionId": "e5805802-f366-4133-b0ca-baad3b1018e5",
"typeId": 14,
"type": "AchUnHold",
"statusId": 21,
"status": "Scheduled",
"responseDescription": null,
"responseCode": null
}

➔ Next to Configurations