Payment Providers

Test provider connection

Verify that the provider credentials are valid by making a test API call to the provider.

post/api/payment-providers/{id}/test

Path parameters

idstring required

Payment provider ID

Response

Connection test result

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Connection successful"
}

Changes

Changed in 1 of the 2 revisions of this API.2

    • the response property message became required for the status 200

      response-property-became-required

    • the response property success became required for the status 200

      response-property-became-required