comecerodocs

List gateway options

GET
/gateways/options

Lists what you can choose from when you add a gateway: the providers for the mode of your token, the settings each one needs, the currencies and the card brands.

Secret and trusted tokens may call this with the gateways read permission.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

Response Body

The gateway options.

application/json
  1. response

What you can choose from when you add a gateway.

account_id?string

The account of the token you called with.

test?boolean

True when you called with a test token. The providers listed are for that mode.

gateway_configs?array<>

The providers you can add, each with the payment types it takes and the settings it needs. In test mode the test provider comes first.

currencies?array<>

Every currency a gateway may take.

card_types?array<string>

Every card brand you can send in card_types.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/gateways/options'
Example Response
{  "account_id": "AB1234",  "test": true,  "gateway_configs": [    {      "provider_id": "test",      "name": "Test Gateway",      "test": true,      "payment_method_types": [        "credit_card"      ],      "fields": []    }  ],  "currencies": [    {      "code": "EUR",      "name": "Euro"    },    {      "code": "USD",      "name": "US Dollar"    }  ],  "card_types": [    "american_express",    "discover",    "mastercard",    "visa"  ]}