Begin a payment flow. Called by the payer's client against the selected payment servicer using inter-service authentication. Returns an opaque token for status polling and a URL to direct the payer through the payment process in a browser.
Input
Encoding
application/jsonproduct
string
Required
Product identifier for the payment being initiated. The format is defined by the payment servicer.
Output
Encoding
application/jsontoken
string
Required
Opaque token used to poll payment status via network.attested.payment.status.
url
stringuri
Required
URL to direct the payer to in a browser to complete the payment flow (entering payment details, confirming terms, etc).
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"input": {
"schema": {
"type": "object",
"required": [
"product"
],
"properties": {
"product": {
"type": "string",
"description": "Product identifier for the payment being initiated. The format is defined by the payment servicer."
}
}
},
"encoding": "application/json"
},
"output": {
"schema": {
"type": "object",
"required": [
"token",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "URL to direct the payer to in a browser to complete the payment flow (entering payment details, confirming terms, etc)."
},
"token": {
"type": "string",
"description": "Opaque token used to poll payment status via network.attested.payment.status."
}
}
},
"encoding": "application/json"
},
"description": "Begin a payment flow. Called by the payer's client against the selected payment servicer using inter-service authentication. Returns an opaque token for status polling and a URL to direct the payer through the payment process in a browser."
}