comecerodocs

Retrieve payment options

GET
/payments/options

Returns what a shopper can pay with on your account for a payment with no cart or invoice: your currencies, the best currency for the caller's location, the payment methods and card types in a currency, and the customer fields to collect. For a cart, use GET /carts/{cart_id}/options instead. Any token type may call it.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

currency?string

The ISO 4217 currency to list payment methods for. Must be one your account takes (400 otherwise). Defaults to your default payment currency.

expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

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.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse
user_ip_address?string

The shopper's IP address, when your server calls with a secret token on the shopper's behalf. Comecero uses it for fraud checks and to find the shopper's country. Only read for a secret token: for every other token the address the request comes from is used. A value that is not a valid IPv4 or IPv6 address is ignored.

Response Body

The payment options.

application/json
  1. response

What a shopper can pay with on your account, for a payment with no cart or invoice: currencies, payment methods, card types and the customer fields to collect.

account_id*string

Your account.

test*boolean

True for test mode.

currencies*array<>

The currencies your account takes.

customer_default_currency*|

The best currency for the caller's location among those you take.

customer_default_country*|

The country of the caller's IP address.

payment_methods*array<>

The payment methods available in the requested currency, or your default one.

card_types*array<string>

The card brands taken in that currency.

customer_required_fields*array<string>

The customer fields that must be sent with a payment, in dot notation.

customer_optional_fields*array<string>

The customer fields you may also collect.

allowed_customer_countries*array<string>

The countries a customer may be in.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/payments/options'
Example Response
{  "account_id": "AB1234",  "test": true,  "currencies": [    {      "code": "USD",      "name": "US Dollar"    },    {      "code": "EUR",      "name": "Euro"    }  ],  "customer_default_currency": "USD",  "customer_default_country": "US",  "payment_methods": [    {      "payment_method_type": "credit_card",      "surcharge": 0,      "currency": "USD",      "paypal_fraudnet_source_id": null,      "stripe_publishable_key": null,      "stripe_account_id": null,      "finix_card_form": null    }  ],  "card_types": [    "Visa",    "MasterCard"  ],  "customer_required_fields": [    "name",    "email",    "billing_address.country"  ],  "customer_optional_fields": [    "phone"  ],  "allowed_customer_countries": [    "US",    "CA"  ]}