How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Fat Zebra Gateway API

The core Fat Zebra payments Gateway — 98 documented operations across 73 paths covering purchases, authorizations and captures, refunds and voids, card tokenization (credit_cards), customers and bank accounts, direct debits and direct credits, chargebacks, batches, recurring payment plans, surcharging, and webhook management. OpenAPI 3.1. Auth is HTTP Basic (username + API token).

Fat Zebra Gateway API is one of 4 APIs that Fat Zebra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments, Gateway, Card Payments, and Tokenization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 98 operations across 73 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://gateway.pmnts-sandbox.io/v1.0.

98 operations 73 paths 0 schemas 9 DELETE48 GET2 PATCH30 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://gateway.pmnts.io/v1.0
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Fat Zebra Gateway API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (sec0). By default, every request must be authenticated.

Paths & Operations 98

Across 73 paths, the API surfaces 98 operations — 9 DELETE, 48 GET, 2 PATCH, 30 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Operations 98
POST
/purchases
Create a purchase with fraud screening
create-a-purchase-with-fraud-screening-1 1 param body → 200
GET
/purchases
List purchases
list-purchases 5 params → 200
POST
/purchases/
Create a purchase using a wallet
create-a-purchase-with-wallet 1 param body → 200400
POST
/purchases/ ​
Create a purchase using a network token passthrough
create-a-purchase-using-token-passthough 1 param body → 200400
POST
/purchases/ ​​
Create a purchase using a wallet passthrough
create-a-purchase-using-wallet-passthrough 1 param body → 200400
POST
/purchases/ ​​​
Create a purchase with a token
create-a-purchase-with-a-token-1 1 param body → 200
POST
/purchases/ ​​​​
Create a purchase, with fraud screening
create-a-purchase-with-fraud-screening 1 param body → 200
POST
/purchases/ ​​​​​
Create an authorization
create-an-authorization 1 param body → 200
PUT
/purchases/{id}
Update an authorization
update-an-authorization 2 params body → 200
DELETE
/purchases/{id}
Release an authorization
release-an-authorization 2 params body → 200
GET
/purchases/{id}
Fetch a purchase
fetch-a-purchase 2 params → 200404
POST
/purchases/{id}/capture
Capture an authorization
capture-an-authorization 2 params body → 200422
POST
/purchases/void
Void a purchase
void-a-purchase 2 params → 200422
GET
/purchases/settlement
List purchases by settlement
list-purchases-by-settlement 3 params → 200400
POST
/credit_cards
Tokenize a card
tokenize-a-card body → 200422
GET
/credit_cards
List tokenized cards
list-tokenized-cards 4 params → 200400
POST
/credit_cards/
Tokenize a card with wallet credentials
tokenize-a-card-with-wallet-credentials body → 200400
PUT
/credit_cards/{token_or_alias}
Update a tokenized card
update-a-tokenized-card 1 param body → 200400
GET
/credit_cards/{token_or_alias}
Fetch a tokenized card
fetch-a-tokenized-card 1 param → 200404
DELETE
/credit_cards/{token_or_alias}
Delete an MDES Token Connect tokenized card
delete-an-mdes-token-connect-tokenized-card 1 param → 200
POST
/refunds
Issue a refund
issue-a-refund body → 200
GET
/refunds
List refunds
list-refunds 4 params → 200400
POST
/refunds/void
Void a refund
void-a-refund 2 params → 200404
GET
/refunds/{id}
Fetch a refund
fetch-a-refund 1 param → 200404
POST
/direct_debits
Create a direct debit
create-a-direct-debit 1 param body → 201422
GET
/direct_debits
List direct debits
list-direct-debits 5 params → 200
PUT
/direct_debits/{id}
Update a direct debit
update-a-direct-debit 2 params body → 200422
DELETE
/direct_debits/{id}
Delete a direct debit
delete-a-direct-debit 2 params → 200404
GET
/direct_debits/{id_or_reference}
Fetch a direct debit
fetch-a-direct-debit 2 params → 200404
POST
/direct_credits
Create a direct credit
create-a-direct-credit 1 param body → 201422
GET
/direct_credits
List direct credits
list-direct-credits 5 params → 200
PUT
/direct_credits/{id}
Update a direct credit
update-a-direct-credit 2 params body → 200422
DELETE
/direct_credits/{id}
Delete a direct credit
delete-a-direct-credit 2 params → 200404
GET
/direct_credits/{id_or_reference}
Fetch a direct credit
fetch-a-direct-credit 2 params → 200404
GET
/chargebacks/{id}
Fetch a chargeback
chargebacks-1 2 params → 200400
PATCH
/chargebacks/{id}
Update a chargeback
update-a-chargeback-2 2 params body → 200400
GET
/chargebacks
List chargebacks
list-chargebacks 1 param → 200400
GET
/chargebacks/{chargeback_id}/notifications/{id}
Fetch a chargeback notification
fetch-a-chargeback-notification-1 3 params → 200400
PATCH
/chargebacks/{chargeback_id}/notifications/{id}
Update a chargeback notification
update-a-chargeback-1 3 params body → 200400
GET
/chargebacks/{id}/notifications
List chargeback notifications
list-chargeback-notifications-1 2 params → 200400
POST
/batches/{filename}
Create a batch
create-a-batch 1 param body → 201
DELETE
/batches/{id}
Delete a batch
delete-a-batch 1 param → 200
GET
/batches/{id}
Fetch a batch
fetch-a-batch 1 param → 200
GET
/batches/{id}/result.csv
Retrieve batch result file
retrieve-batch-result-file 1 param → 200422
GET
/batches
List all batches
list-all-batches 2 params → 200
POST
/customers
Create a customer
create-a-customer body → 201
GET
/customers
List customers
list-customers 2 params → 200
PUT
/customers/{id}
Update a customer
update-a-customer 1 param → 200
DELETE
/customers/{id}
Delete a customer
delete-a-customer 1 param → 200
GET
/customers/{id}
Fetch a customer
fetch-a-customer 1 param → 200
POST
/bank_accounts
Create a bank account
create-a-bank-account → 201422
GET
/bank_accounts
List bank accounts
list-bank-accounts 4 params → 200
GET
/bank_accounts/{id}
Fetch a bank account
fetch-a-bank-account 1 param → 200
GET
/applicable_surcharge
Get applicable surcharge
get-applicable-surcharge 4 params → 200400
POST
/web_hooks
Create a webhook
create-a-webhook body → 200422
GET
/web_hooks
List webhooks
list-webhooks 2 params → 200
PUT
/web_hooks/{id}
Update a webhook
update-a-webhook 1 param body → 200400
DELETE
/web_hooks/{id}
Delete a webhook
delete-a-webhook 1 param → 200404
POST
/payment_plans
Create a payment plan
create-a-payment-plan body → 200422
GET
/payment_plans
List payment plans
list-payment-plans 4 params → 200400
PUT
/payment_plans/{id_or_reference}
Update a payment plan
update-a-payment-plan 1 param body → 200404
DELETE
/payment_plans/{id_or_reference}
Cancel a payment plan
cancel-a-payment-plan 1 param → 200404
GET
/payment_plans/{id_or_reference}
Fetch a payment plan
fetch-a-payment-plan 1 param → 200404
GET
/settlement/totals
Fetch settlement totals
fetch-settlement-totals 2 params → 200400
GET
/invoices/{reference}
Fetch an invoice
fetch-an-invoice 1 param → 200
GET
/invoice_imports/4a70e8d5-1d7d-441d-9ea2-30d15ff0f2e8
Check replacement status
check-invoice-import-status → 200400
PUT
/invoices
Replace all invoices
import-invoices → 200400
GET
/paypal/orders
List orders
paypal-list-orders 5 params → 200
GET
/paypal/orders/{id}
Fetch an order
paypal-fetch-an-order 2 params → 200404
GET
/paypal/authorizations
List authorizations
paypal-list-authorizations 5 params → 200
GET
/paypal/authorizations/{id}
Fetch an authorization
paypal-fetch-an-authorization 2 params → 200404
POST
/paypal/authorizations/{id}/capture
Capture an authorization
paypal-capture-an-authorization 1 param body → 200400401404
POST
/paypal/authorizations/{id}/void
Void an authorization
paypal-void-an-authorization 1 param → 200401404422
GET
/paypal/captures
List captures
paypal-list-captures 5 params → 200
GET
/paypal/captures/{id}
Fetch a capture
paypal-fetch-a-capture 2 params → 200404
POST
/paypal/captures/{id}/refund
Refund a capture
paypal-refund-a-capture 2 params body → 200400401404
GET
/paypal/refunds
List refunds
paypal-list-refunds 5 params → 200
GET
/paypal/refunds/{id}
Fetch a refund
paypal-fetch-a-refund 2 params → 200404
GET
/paypal/billing_agreements
List billing agreements
paypal-list-billing-agreements 5 params → 200
GET
/paypal/billing_agreements/{id}
Fetch a billing agreement
paypal-fetch-a-billing-agreement 2 params → 200404
POST
/paypal/billing_agreements/{id}/cancel
Cancel a billing agreement
paypal-cancel-a-billing-agreement 2 params → 200404422
POST
/paypal/billing_agreements/{id}/charge
Charge a billing agreement
paypal-charge-a-billing-agreement 2 params body → 200404422
POST
/authenticate/session
Generate a JWT token
generate-a-jwt-token 1 param body → 200
GET
/authenticate/decode_session
Decode a JWT token
decode-a-jwt-token 2 params → 200
POST
/authenticate
Authenticate a transaction
authenticate-a-transaction 1 param body → 200
POST
/oauth_clients
Create an OAuth Client
create-an-oauth-client body → 200422
GET
/reports/payouts/{date}
Fetch a payout report for date
fetch-a-payout-report-for-date 2 params → 200400
GET
/reports/payouts/{date}/transactions
Fetch a payout's transactions for date
fetch-a-payout-report-for-date-transactions 2 params → 200400
GET
/disputes
List disputes
list-disputes 9 params → 200422
GET
/transactions/{transaction_fatzebra_id}/dispute
Fetch dispute
fetch-dispute 2 params → 200404422
PUT
/transactions/{transaction_fatzebra_id}/dispute/accept
Accept dispute
accept-dispute 2 params → 201404422
POST
/utlities/mastercard/click_to_pay/registration
Create Registration
mastercard-clicktopay-create-registration → 200
GET
/utilities/mastercard/click_to_pay/registration
Check Registration
mastercard-clicktopay-check-registration → 200
POST
/utilities/apple_pay/domains/www.example.com
Register (Create) an Apple Pay on the Web Domain
register-create-an-apple-pay-on-the-web-domain body → 200404
GET
/utilities/apple_pay/domains/www.example.com
Check (Get) an Apple Pay on the Web Domain
check-get-an-apple-pay-on-the-web-domain → 200404
DELETE
/utilities/apple_pay/domains/www.example.com
Remove (Delete) an Apple Pay on the Web Domain
remove-delete-an-apple-pay-on-the-web-domain → 202404
GET
/utilities/apple_pay/domains
List Apple Pay (web) domains
list-apple-pay-web-domains → 200
GET
/health
get_health 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fat-zebra-gateway.json Raw ↑

Other APIs Fat Zebra publishes across the network.

Fat Zebra Partner API
Fat Zebra Billing API
Fat Zebra FDMS TPP Merchant Onboarding API
Where this information came from

This is an independent, third-party profile of Fat Zebra Gateway API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.