Payment Gateways

  1. List Payment Gateways
  2. Get a single Payment Gateway

Parameters

Name Type Read/Write Description
id BigInteger Read Uniq identifier.
name String Read Payment Gateway’s name serving as an additional identifier.
test Boolean Read Submitted requests will not be charged if set to true.
gateway_name String Read Payment Gateway’s name, available values are described in: enums section
credentials Object Read Credentials used for payment gateway authentication.
supported_cardtypes Array Read Array of String values containing supported cardtypes for selected gateway.
supported_currencies Array Read Array of string values containing supported currencies for selected gateway.
tokenize_credit_card_details Boolean Read Credit Card details will be tokenized if set to true.
host_booking_pay_wallet_id String Read Wallet ID for BookingPay host.
created_at Time Read Payment Gateway’s creation time.
updated_at Time Read Payment Gateway’s creation time.

List Payment Gateways

List all Payment Gateways for a given account.

GET /payment_gateways

Response

{
  "links": {
    "payment_gateways.account": "https://www.bookingsync.com/api/v3/accounts/{payment_gateways.account}"
  },
  "payment_gateways": [
    {
      "id": 1,
      "credentials": {
        "login": "login"
      },
      "gateway_name": "gateway_name",
      "host_booking_pay_wallet_id": null,
      "name": "TestingGatewayName",
      "supported_cardtypes": [
        "visa",
        "master"
      ],
      "supported_currencies": [
        "EUR",
        "THB"
      ],
      "test": true,
      "tokenize_credit_card_details": true,
      "created_at": "2019-08-15T14:27:48Z",
      "updated_at": "2019-08-21T16:07:47Z",
      "links": {
        "account": 1
      }
    }
  ],
  "meta": {
    "Link": {
      "first": "https://www.bookingsync.com/api/v3/payment_gateways/1.json?bookings%5B%5D%5Bcanceled_at%5D=&page=1",
      "last": "https://www.bookingsync.com/api/v3/payment_gateways/1.json?bookings%5B%5D%5Bcanceled_at%5D=&page=1"
    },
    "X-Per-Page": "100",
    "X-Total-Count": "1",
    "X-Total-Pages": "1"
  }
}

Get a single Payment Gateway

Returns a single payment gateway identified by ID.

GET /payment_gateways/:payment_gateway_id

Response

{
  "links": {
    "payment_gateways.account": "https://www.bookingsync.com/api/v3/accounts/{payment_gateways.account}"
  },
  "payment_gateways": [
    {
      "id": 1,
      "credentials": {
        "login": "login"
      },
      "gateway_name": "gateway_name",
      "host_booking_pay_wallet_id": null,
      "name": "TestingGatewayName",
      "supported_cardtypes": [
        "visa",
        "master"
      ],
      "supported_currencies": [
        "EUR",
        "THB"
      ],
      "test": true,
      "tokenize_credit_card_details": true,
      "created_at": "2019-08-15T14:27:48Z",
      "updated_at": "2019-08-21T16:07:47Z",
      "links": {
        "account": 1
      }
    }
  ],
  "meta": {
    "Link": {
      "first": "https://www.bookingsync.com/api/v3/payment_gateways/1.json?bookings%5B%5D%5Bcanceled_at%5D=&page=1",
      "last": "https://www.bookingsync.com/api/v3/payment_gateways/1.json?bookings%5B%5D%5Bcanceled_at%5D=&page=1"
    },
    "X-Per-Page": "100",
    "X-Total-Count": "1",
    "X-Total-Pages": "1"
  }
}