Register

We are improving our documentation

We're currently working on improving this page to provide you with the best possible experience. Please bear with us while we make some changes.

Thank you for your patience!

Registers a customer's payment instrument for future charges (Debits or Preauthorizations)

POST /transaction/{apiKey}/register

Path parameters

Name	Type	Description
apiKey	required`string`	API Key of Connector

{
  "cardData": {
    "cardHolder": "Alex Smith",
    "pan": "4111111111111111",
    "cvv": "123",
    "expirationMonth": "12",
    "expirationYear": "2029"
  },
  "merchantTransactionId": "your-unique-identifier",
  "successUrl": "https://shop.example.org/checkout/success",
  "cancelUrl": "https://shop.example.org/checkout/cancelled",
  "errorUrl": "https://shop.example.org/checkout/error",
  "callbackUrl": "https://api.example.org/callback",
  "description": "Purchase description shown on credit card statement.",
  "customer": {
    "identification": "616c6578-2e73-6d69-7468-406578616d70",
    "firstName": "Alex",
    "lastName": "Smith",
    "billingCountry": "US",
    "email": "[email protected]",
    "ipAddress": "198.51.100.123"
  }
}