Payment gateways

Retrieve a payment gateway

Changed on

Returns the details of a payment gateway.

Payment gateways are integrations created through Shipmondo to payment service providers. They are used to capture and cancel payments through Shipmondo.

get/payment_gateways/{id}

Request

  • Base URL
    https://sandbox.shipmondo.com/api/public/v3
  • URL
    https://sandbox.shipmondo.com/api/public/v3/payment_gateways/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

ID for the payment gateway to be included in the filter

Response

Successful.

idinteger

Unique identifier of the object.

namestring

User-specified name of the payment gateway.

provider'epay' | 'quick_pay' | 'stripe' | 'yourpay' | 'penso_pay' | 'dibs' | 'on_pay' | 'reepay' | 'klarna' | 'shopify_payments' | 'paypal' | 'dibs_easy' | 'paylike' | 'bambora_checkout' | 'anyday' | 'freepay' | 'swiipe' | 'shipmondo_payments' | 'vipps' | 'dummy_payment_gateway' | 'pensopay' | 'epay_v2' | 'kustom'

Specific code of the gateway used to refer to the provider.

merchant_numberstring

Mechant number of the payment gateway.

Example response

{
  "id": 5314,
  "name": "QuickPay 1",
  "provider": "quick_pay",
  "merchant_number": "12345678"
}

Changes

    • warning

      added the new kustom enum value to the response property for the response status