Register Profile

Purpose

As part of onboarding a new payment platform, a webhook event will be sent to transfer the relevant account information and in response receive the necessary webhook URLs for each integration function

Request Parameters

AttributeDefinition
gatewayProfileIdThe unique identifier set in Deliverect for the payment platform
accountIdThe unique customer accountId
apiKeyA unique identifier of the customer account known to the payment platform
webhookUrlThe endpoint to where payment events are to be sent

Response Parameters

AttributeDefinition
requestPaymentURLThe endpoint where payment request events should be sent
refundPaymentURLThe endpoint where payment refund events should be sent
unregisterGatewayProfileURLThe endpoint used to unregister a payment platform from a customer account
Body Params
string
required

Unique identifier of the payment gateway within a Deliverect customer account

string
required
string
required

API key is the unique identifier of the customer within the payment gateway

string
required

Webhook URL which partners will send payment related update events

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json