Pay In schemas
Learn about Pay In (money in) transaction schemas
These transaction schemas cover the most common pay in, also known as money in, transaction tasks in Payabli.
Make a transaction with the embeddedMethodUI component
Making a transaction with the embeddedMethodUI component happens over several steps. Use the component to store payment methods and make a payment transaction.
This flowchart explains the basic steps for the task. Hover over a step for more information.
Run payabliExec(method, parameters)
Here, the action is set to method. Send the paymentDetail and customerData object in parameters.
Payment method saved The payment method is saved and includes the data sent as parameters. An ID for the payment method is returned, which is then used to make transactions.
Callback function Use a callback function to send a transaction that uses the new payment method.
Response
Save a payment method with the API
You can save a payment method using the API with the token storage endpoint. If you want to store the token permanently, make sure that the temporary query parameter is set to false.
This flowchart explains the basic steps for the task. Hover over a step for more information.
POST to addMethod endpoint
Make a POST request to the addMethod endpoint. Set temporary to true to create a single use token that’s good for 12 hours. Set temporary to false to save a permanent token.
Response
Make a POST request to the addMethod endpoint. Set temporary to true to create a single use token that’s good for 12 hours. Set temporary to false to save a permanent token.
Make a transaction with a stored payment method
If you already have a stored payment method for the user, you can just make a POST request to the getpaid endpoint using the storedMethodId.
This flowchart explains the basic steps for the task. Hover over a step for more information.
POST to transaction endpoint
using storedMethodId
Make a POST request to a transaction endpoint (like /MoneyIn/getpaid). Use the saved method’s storedMethodId in the paymentMethod object.
Response
Make a POST request to a transaction endpoint (like /MoneyIn/getpaid). Use the saved method’s storedMethodId in the paymentMethod object.
Void and refund transactions
Learn more about the difference between voids and refunds in Cancel a Pay In transaction.
Void a transaction
To void an unsettled transaction, send a POST request to the /v2/MoneyIn/void/{transId} endpoint using the transaction’s paymentTransId as the transId parameter.
This flowchart explains the basic steps for the task. Hover over a step for more information.
POST to v2 void endpoint
using transId
Make a POST request to the v2 void endpoint (/v2/MoneyIn/void), using the transaction’s paymentTransId as the transId parameter.
Response
Make a POST request to the v2 void endpoint (/v2/MoneyIn/void), using the transaction’s paymentTransId as the transId parameter.
Refund a transaction
To refund a settled transaction, send a POST request to the /v2/MoneyIn/refund endpoint with the transId, plus the amount for partial refunds.
This flowchart explains the basic steps for the task. Hover over a step for more information.
POST to v2 refund endpoint
using transId, plus amount for partial refunds
Make a POST request to the v2 refund endpoint (/v2/MoneyIn/refund), using the transaction’s paymentTransId as the transId parameter. Include the amount for a partial refund.
Response
Make a POST request to the v2 refund endpoint (/v2/MoneyIn/refund), using the transaction’s paymentTransId as the transId parameter. Include the amount for a partial refund.
Related resources
See these related resources to help you get the most out of Payabli.
References
- Pay In statuses - Learn about Pay In (money in) statuses