v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Payment gateways

List all payment gateways

Returns a list of payment gateways.

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

get/payment_gateways

Query parameters

idinteger

ID for the payment gateway to be included in the filter

per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

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'

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"
  }
]