Commerce
Payrexx
8min
with the payrexx app in {{product name}} , you can manage the cash transactions, manual payouts, new subscriptions, paylinks, qr codes, and gateways in your payrexx account requirements to use the payrexx app in {{product name}} , you must have a payrexx account for subscription information, refer to the payrexx plans connect payrexx and {{product name}} to get started, you must first create a connection between payrexx and {{product name}} , allowing the two services to communicate to create the connection, you need to payrexx docid 3yfna4xc6grv4xbrzm7n4 payrexx docid 3yfna4xc6grv4xbrzm7n4 obtain your api key in payrexx before you create the connection in {{product name}} , you should first obtain an api key in your payrexx account to obtain the api key log in to your payrexx account navigate to api & plugins create a new api key for your connection to make you'll use this value in the api key connection field in {{product name}} create the connection in {{product name}} once you have your payrexx api key, you're ready to create the connection in {{product name}} to create the connection log in to your {{product name}} account, add a payrexx module to your {{scenario singular lowercase}} , and click create a connection optional in the connection name field, enter a name for the connection in the instance name field, enter your payrexx account name in the api key field, enter the api key you copied from your payrexx account in the api version field, select an api version for your request in the platform field, select the platform that you will work on this field is only relevant for non payrexx merchants who work with another platform click save if prompted, authenticate your account and confirm access you've successfully created the connection and can now use the payrexx app in your {{scenario plural lowercase}} if you want to make changes to your connection in the future, follow the steps connect an application docid\ so88fm6pkt0g adkddfzz set up a payrexx webhook the payrexx app has instant modules — webhooks that watch for certain changes in payrexx and immediately start your {{scenario singular lowercase}} when those changes happen to use these modules, you must set up the webhook in your payrexx account to set up the webhook add a payrexx instant module to your {{scenario singular lowercase}} and click create a webhook optional enter a name for the webhook in the webhook name field i n the connection field, select a connection for the webhook if you haven't created a payrexx connection yet, refer to the payrexx docid 3yfna4xc6grv4xbrzm7n4 section above click save > copy address to clipboard you'll paste this address in your payrexx account log in to your payrexx account in the left sidebar, click webhooks click add webhook in the webhook url field, paste the webhook url you have copied in step 4 above select the webhook events based on the module you selected before set the webhook type to json click add your webhook is now set up when the selected change occurs in payrexx , {{product name}} will immediately be notified and start your {{scenario singular lowercase}} payrexx modules after connecting to the payrexx app, you can use the following types of modules to build your {{scenario plural lowercase}} triggers watch payouts receives payout information on every new payout made watch subscriptions receives subscription information on every new or changed subscription watch transactions receives transaction information on every new or changed transaction actions cancel a waiting transaction cancel a waiting transaction by id charge a pre authorized/reserved transaction debit an amount based on a previous tokenisation or reservation by the previous transation id create a cash transaction create a new cash transaction which will be added to the transaction history in your payrexx account create a manual payout create a new manual payout create a new subscription create a new subscription which will be recurringly billed to the user you provide create a paylink create a new paylink create a qr code create a new qr code create gateway create a new payment gateway delete a gateway delete a payment gateway by id delete a paylink delete a paylink by id delete a qr code delete a qr code by uuid delete a qr code scan delete a qr code scan by session id delete a reserved transaction delete a transaction by id delete a subscription delete a subscription by id login a subscription customer create an authentication link for subscription users make an api call make a custom api call to the payrexx rest api refund a transaction create a refund for a previously made transaction retrieve a gateway retrieve a payment gateway by id retrieve a paylink retrieve a paylink by id retrieve a payout with details retrieve a payout by id with detailed information retrieve a payout without details retrieve a payout by id without detailed information retrieve a qr code retrieve a qr code by uuid retrieve a transaction retrieve a transaction by id send a transaction mail receipt send a receipt by e mail for a transaction update a subscription change existing subscription configuration like amount, currency, purpose or vat rate update pre authorized/tokenization contact details update the contact details of a pre authorization or tokenization transaction s earches retrieve payouts retrieve a list of payouts made in your payrexx account retrieve transactions retrieve transactions made through payrexx templates you can look for payrexx templates in make's template gallery , where you'll find thousands of pre created {{scenario plural lowercase}} payrexx resources payrexx rest api payrexx documentation payrexx merchant payrexx developer