PaidYET Gateway transaction API
Transaction Endpoints
Sale
This page will show you how to perform a sale transaction, whether it be via credit/debit card, a tokenized card, check, or cash. Specify what type of sale you are performing via the command parameter. While this allows for great flexibility on the user-facing API, this one endpoint may accept/reject certain parameters based on the type of sale being performed. Please refer to the typical use cases for specific implementation details.
Credit Card
Processing a credit/debit card sale uses the sale command. An example of this transaction type is shown here.
| Parameter Name | Type | Description |
| Entry 1 | Entry 2 | Entry 3 |
| Entry 4 | Entry 5 | Entry 6 |
| Entry 7 | Entry 8 | Entry 9 |
ACH
ACH Status events fire when updates from the ACH processor are received. The following webhook events are available for ACH Status Updates:
| Event Name | Description |
| ach.submitted | ACH status updated to submitted. |
| ach.settled | ACH status updated to settled. |
| ach.returned | ACH status updated to returned. |
| ach.voided | ACH status updated to voided. |
| ach.failed | ACH status updated to failed. |
| ach.note_added | Note added to ACH transaction. |
Scheduled/Recurring
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Auth Only
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Capture
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Void
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Refund
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Retrieve Transaction Details
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Tokenize Card
Dictumst vestibulum rhoncus est pellentesque elit ullamcorper dignissim. Orci eu lobortis elementum nibh tellus molestie nunc. Aliquet nibh praesent tristique magna sit amet purus. Gravida cum sociis natoque penatibus et magnis dis. Mauris in aliquam sem fringilla ut morbi. Viverra vitae congue eu consequat ac felis. Risus viverra adipiscing at in tellus integer feugiat scelerisque. Ullamcorper malesuada proin libero nunc consequat. Pulvinar elementum integer enim neque volutpat ac tincidunt. Felis imperdiet proin fermentum leo vel orci. Rutrum quisque non tellus orci ac auctor augue. Non nisi est sit amet facilisis magna etiam tempor orci. Tellus pellentesque eu tincidunt tortor aliquam. Eget mauris pharetra et ultrices. Cursus mattis molestie a iaculis at erat pellentesque. Vitae purus faucibus ornare suspendisse sed nisi lacus sed. Euismod lacinia at quis risus sed vulputate odio ut enim. Ipsum suspendisse ultrices gravida dictum fusce ut placerat orci nulla. Sed arcu non odio euismod lacinia at quis risus sed. Venenatis a condimentum vitae sapien pellentesque habitant morbi tristique.
Devices
Dictumst vestibulum rhoncus est pellentesque elit ullamcorper dignissim. Orci eu lobortis elementum nibh tellus molestie nunc. Aliquet nibh praesent tristique magna sit amet purus. Gravida cum sociis natoque penatibus et magnis dis. Mauris in aliquam sem fringilla ut morbi. Viverra vitae congue eu consequat ac felis. Risus viverra adipiscing at in tellus integer feugiat scelerisque. Ullamcorper malesuada proin libero nunc consequat. Pulvinar elementum integer enim neque volutpat ac tincidunt. Felis imperdiet proin fermentum leo vel orci. Rutrum quisque non tellus orci ac auctor augue. Non nisi est sit amet facilisis magna etiam tempor orci. Tellus pellentesque eu tincidunt tortor aliquam. Eget mauris pharetra et ultrices. Cursus mattis molestie a iaculis at erat pellentesque. Vitae purus faucibus ornare suspendisse sed nisi lacus sed. Euismod lacinia at quis risus sed vulputate odio ut enim. Ipsum suspendisse ultrices gravida dictum fusce ut placerat orci nulla. Sed arcu non odio euismod lacinia at quis risus sed. Venenatis a condimentum vitae sapien pellentesque habitant morbi tristique.
Register
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Initiate Transaction
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Retrieve Transaction Status
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Customers
Dictumst vestibulum rhoncus est pellentesque elit ullamcorper dignissim. Orci eu lobortis elementum nibh tellus molestie nunc. Aliquet nibh praesent tristique magna sit amet purus. Gravida cum sociis natoque penatibus et magnis dis. Mauris in aliquam sem fringilla ut morbi. Viverra vitae congue eu consequat ac felis. Risus viverra adipiscing at in tellus integer feugiat scelerisque. Ullamcorper malesuada proin libero nunc consequat. Pulvinar elementum integer enim neque volutpat ac tincidunt. Felis imperdiet proin fermentum leo vel orci. Rutrum quisque non tellus orci ac auctor augue. Non nisi est sit amet facilisis magna etiam tempor orci. Tellus pellentesque eu tincidunt tortor aliquam. Eget mauris pharetra et ultrices. Cursus mattis molestie a iaculis at erat pellentesque. Vitae purus faucibus ornare suspendisse sed nisi lacus sed. Euismod lacinia at quis risus sed vulputate odio ut enim. Ipsum suspendisse ultrices gravida dictum fusce ut placerat orci nulla. Sed arcu non odio euismod lacinia at quis risus sed. Venenatis a condimentum vitae sapien pellentesque habitant morbi tristique.
Add
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Retrieve
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Add Card on File
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Remove Card on file
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Webhooks
Dictumst vestibulum rhoncus est pellentesque elit ullamcorper dignissim. Orci eu lobortis elementum nibh tellus molestie nunc. Aliquet nibh praesent tristique magna sit amet purus. Gravida cum sociis natoque penatibus et magnis dis. Mauris in aliquam sem fringilla ut morbi. Viverra vitae congue eu consequat ac felis. Risus viverra adipiscing at in tellus integer feugiat scelerisque. Ullamcorper malesuada proin libero nunc consequat. Pulvinar elementum integer enim neque volutpat ac tincidunt. Felis imperdiet proin fermentum leo vel orci. Rutrum quisque non tellus orci ac auctor augue. Non nisi est sit amet facilisis magna etiam tempor orci. Tellus pellentesque eu tincidunt tortor aliquam. Eget mauris pharetra et ultrices. Cursus mattis molestie a iaculis at erat pellentesque. Vitae purus faucibus ornare suspendisse sed nisi lacus sed. Euismod lacinia at quis risus sed vulputate odio ut enim. Ipsum suspendisse ultrices gravida dictum fusce ut placerat orci nulla. Sed arcu non odio euismod lacinia at quis risus sed. Venenatis a condimentum vitae sapien pellentesque habitant morbi tristique.
Transaction Complete
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Transaction Changed
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.
Batch Settled
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi. Risus quis varius quam quisque id diam. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam erat. Habitasse platea dictumst vestibulum rhoncus est. Nunc consequat interdum varius sit amet. Risus nec feugiat in fermentum posuere urna nec tincidunt. Vitae sapien pellentesque habitant morbi tristique senectus et. Ultricies tristique nulla aliquet enim tortor at auctor. Non quam lacus suspendisse faucibus interdum posuere lorem ipsum dolor. Tempor orci eu lobortis elementum nibh tellus molestie nunc. Augue eget arcu dictum varius duis at consectetur. Faucibus pulvinar elementum integer enim neque volutpat ac tincidunt vitae. Placerat vestibulum lectus mauris ultrices eros in cursus turpis. Tortor condimentum lacinia quis vel eros donec ac. Mauris in aliquam sem fringilla ut morbi tincidunt augue interdum.