Create Payment

Create Payment (Checkout)

📘

This call must be performed from your backend server!
The Create-checkout-link call requires your private_key (your secret password) which should not be exposed on the client-side.

Make a POST /pay-ins/checkout request:

curl --location --request POST 'https://sandbox.unipaas.com/platform/pay-ins/checkout' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{PRIVATE_KEY}}' \
--data-raw '{
  "amount": 100,
  "currency": "GBP",
  "orderId": "1000456",
  "description": "Iphone case",
  "email": "[email protected]",
  "phone": "+447911123456",
  "country": "GB",
  "reference": "100456",
  "invoiceUrl": "http://yourcompany.com/invoice.pdf", //OPTIONAL
  "dueDate": "2020-12-13", //OPTIONAL
  "vatAmount": 19, //OPTIONAL
  "successfulPaymentRedirect": "http://yourcompany.com/redirect", //OPTIONAL
  "items": [
    {
      "name": "Iphone case",
      "amount": 100,
      "vendorId": "5ee8e655a65f08fcd71fe4d9",
      "platformFee": 0,
      "quantity": 1
    }
  ],
  "billingAddress": {
    "firstName": "string",
    "lastName": "string",
    "city": "London",
    "country": "GB",
    "line1": "64 New Cavendish Street",
    "line2": "",
    "postalCode": "W1G 8TB",
    "state": ""
  },
  "shippingSameAsBilling": true,
  "shippingAddress": {
    "firstName": "string",
    "lastName": "string",
    "city": "London",
    "country": "GB",
    "line1": "64 New Cavendish Street",
    "line2": "",
    "postalCode": "W1G 8TB", 
    "state": ""
  },
  "metadata": {
    "CustomerID": "457349"
  }
}'

In the response you will find the shortLink field, which contains the URL of the checkout page.

Optional address fields

We highly recommend you pass information about the consumer's address when creating a checkout. Passing the billing and shipping (for physical goods) addresses will increase the success rate of the transaction.

In case shipping address is not applicable (for non-physical goods), set the shippingSameAsBilling flag to true.

Note: Add a 2-letter ISO state code (for customers based in the US, Canada, and India only).