PCpci-proxy

POST /v1/requests

Generate Document Vault upload request link

Request

  • Base URL
    https://api.vault.sandbox.pci-proxy.com
  • URL
    https://api.vault.sandbox.pci-proxy.com/v1/requests
  • Auth
    API key in header pci-proxy-api-key

Request body

referencestring required
successUrlstring required
cancelUrlstring required
errorUrlstring required
webhookEndpointstring
contextobject

Example request

{
  "reference": "20230131-0123456789",
  "successUrl": "https://example.org?success",
  "cancelUrl": "https://example.org?cancel",
  "errorUrl": "https://example.org?error",
  "webhookEndpoint": "https://example.org?webhook",
  "context": {
    "First Name": "John",
    "Last Name": "Doe",
    "Credit Card": "xxxx xxxx xxxx 4242"
  }
}

Response

Success

linkstring

URL of the public Document Vault upload page

Changes

No recorded changes to this operation across all 1 revision of this API.