Skip to main content

Registrations API

POST/rest/register

The Registrations API is used to register card information for use in a future payment. The difference between this API and the Authorization API is that it does not require an amount to be blocked for a future deduction.

Registrations API returns tokenized transaction ID, which is used later on with any amount, to make an actual payment.

Registration API Parameters​

Registration API parameters are identical to Payment API. Please, refer back for details there.

Registration API Response​

Registration API response is identical to Payment API. Please, refer back for details there.

Use Case: Register a Card for Future Payments​

  1. Send a POST request to /rest/register with the required parameters.
  2. The response will contain a client_action: "redirect" with a URL in action_data. Redirect the end user to this URL.
  3. The end user enters their card data on the hosted payment page and is redirected back to your success_url or error_url.
  4. The transaction status should now be registered. Store the returned transaction_id — you will need it as original_transaction_id in subsequent payment requests.
  5. When you are ready to charge the card, send a request to the Payment API with original_transaction_id set to the ID from the registration. Set recurring=1 if you intend to make recurring payments.
info

This API may generally used for Card payments. If you have a need to use for any other payment methods, please contact us.

caution

Depending on the payment service provider, the system may try to make a small authorization on the credit card and immediately void it, to ensure that the card number is actually usable. Because this method involves the end user entering credit card data, it requires redirection.

Last updated on