Transactions
Creation of an ACH draft by a merchant or customer in exchange for the products or services of a merchant. Transactions utilize the customer’s routing and account information.
HTTP Method: POST
Use this method to create a transaction.
https://1d3.api.vericheck.com/transactions
APIKey="api_aaabbbcccdddeeefffggghhhiiijjjkkklll";
MerchantID="mer_7sdkf023jossdjf2398ald";
time curl -u $APIKey: -XPOST -d '{
"merchant_id":"'$MerchantID'",
"amount":542.51,
"description":"Office Furniture",
"type":"debit",
"standard_entry_class":"WEB",
"customer":{
"name":"Testy BooJack",
"account_number":"2619383845",
"routing_number":"082000073",
"account_type":"checking"
}
}' https://1d3.api.vericheck.com/transactions
{
"merchant_id":"mer_7sdkf023jossdjf2398ald",
"amount":542.51,
"description":"Office Furniture",
"type":"debit",
"standard_entry_class":"PPD",
"customer":{
"name":"Jason Smith",
"account_number":"2619383845",
"routing_number":"082000073",
"account_type":"checking"
}
}
{
"merchant_id":"mer_7sdkf023jossdjf2398ald",
"amount":65.14,
"description":"Office Furniture",
"type":"debit",
"standard_entry_class":"WEB",
"customer":{
"id":"cus_2k1620ikf0k3235gf343"
}
}
{
"success":true,
"payload":{
"id":"txn_2387jmsjm234asdf02sf2"
}
}
Transaction Object
Field | Data Type | Required | Description |
---|---|---|---|
id | string | no | transaction identifier that begins with prefix 'txn_xxxxxxxxxxx' |
merchant_id | string | yes | unique identifier of the merchant that begins with prefix 'mer_xxxxxxxxx' |
amount | number | yes | the monetary value |
description | string | yes | description of the transaction |
type | string ('debit', 'credit') | yes | debit is ACH transaction that is intended to withdraw funds from a Receiver’s account for deposit into Merchant’s Settlement Account credit is ACH transaction that is intended to deposit funds into a Receiver’s account which has been withdrawn from Merchant’s Settlement Account. |
standard_entry_class | string | yes | the standard_entry_classes are 3 character codes used to identify various types of entries. See http://www.vericheck.com/ach-transaction-types/ for more details. |
check_number | string | yes for BOC, POP | the check_number is the identifying number of a check. |
check_image_front | string; base64 encoded | yes for POP, ICL, BOC | front image copy of the check associated with the account. |
check_image_back | string; base64 encoded | yes for POP, ICL, BOC | back image copy of the check associated with the account. |
customer | object; either id or whole object | yes | full customer credentials which includes name, routing number, account number, and account type or customer token that begins with prefix 'cus_xxxxxxxxxxx'. |
HTTP Method: PUT
This method is used to void or reverse transactions.
Void Transaction
https://1d3.api.vericheck.com/transactions/{transaction_id}/void
Does not require a request body.
Reverse Transaction
https://1d3.api.vericheck.com/transactions/{transaction_id}/reverse
Does not require a request body
TransactionUUID="txn_aaabbbcccdddeeefffggghhhiiijjjkkklll";
APIKey="api_aaabbbcccdddeeefffggghhhiiijjjkkklll";
MerchantID="mer_aaabbbcccdddeeefffggghhhiiijjjkkklll";
time curl -X PUT https://1d3.api.vericheck.com/transactions/txn_aaabbbcccdddeeefffggghhhiiijjjkkklll/reverse -u api_aaabbbcccdddeeefffggghhhiiijjjkkklll -H 'merchant_id: mer_aaabbbcccdddeeefffggghhhiiijjjkkklll'
{
"success":true,
"payload":{
"id":"txn_2387jmsjm234asdf02sf2"
}
}
Updated less than a minute ago