v1

latestOpenAPI 3.0.3Apache 2.02026-07-24153058.9 KB

Order

Create a new order

post/api/v1/orders

Request body

transactionType'SALE' | 'AUTH' | 'VERIFY'

cartIdstring required

descriptionstring

testboolean

Example request

{
  "transactionType": "SALE",
  "cartId": "a1b2c3d4",
  "amount": {
    "value": 1,
    "currency": "AED"
  },
  "description": "My purchase",
  "customer": {
    "email": "someuser@test.com",
    "name": {
      "title": "Mr",
      "firstName": "Some",
      "lastName": "User"
    },
    "address": {
      "line1": "addr1",
      "line2": "addr2",
      "line3": "addr3",
      "city": "Dubai",
      "country": "AE"
    },
    "phone": "052858585"
  },
  "test": true,
  "filter": {
    "cards": [
      "411111",
      "412535-7256",
      "511111"
    ]
  },
  "webhooks": [
    {
      "url": "https://test.webhook.com/"
    }
  ]
}

Response

Order created successfully

refstring required

status'PENDING' | 'AUTHORISED' | 'PAID' | 'CANCELLED' | 'DECLINED' required

cartIdstring

Example response

{
  "ref": "5B1F09D976B1FE66516E97D318ED5D8A57F3CF0078DC56ACA137A4ED356C663C",
  "status": "PENDING",
  "cartId": "a1b2c3d4",
  "amount": {
    "value": 1,
    "currency": "AED"
  },
  "_links": {
    "self": {
      "method": "GET",
      "href": "https://secure.telr.com/api/v1/orders/{ref}"
    },
    "auth": {
      "method": "GET",
      "href": "https://secure.telr.com/api/v1/orders/{ref}/auth?code={value}"
    }
  }
}