# Encoded Gateway API > Developer documentation for building against the Encoded Gateway API. > Production base URL: https://prod.encoded.services/api/v1 > Sandbox base URL: https://sit.encoded.services/api/v1 ## Gateway API Reference - [OpenAPI v1 YAML](http://docs.encoded.services/api/static/v1/encoded_openapi.yaml) - [OpenAPI v1 JSON](http://docs.encoded.services/api/static/v1/encoded_openapi.json) - [OpenAPI v1 YAML alias](http://docs.encoded.services/api/static/encoded_openapi.yaml) - [Gateway API Reference](http://docs.encoded.services/api-reference/v1) ## Reporting API Reference - [OpenAPI v1 YAML](http://docs.encoded.services/api/static/reporting/v1/openapi.yaml) - [OpenAPI v1 JSON](http://docs.encoded.services/api/static/reporting/v1/openapi.json) - [Reporting API Reference](http://docs.encoded.services/reporting-api-reference/v1) ## Authorisation API Reference - [OpenAPI v1 YAML](http://docs.encoded.services/api/static/authorisation/v1/openapi.yaml) - [OpenAPI v1 JSON](http://docs.encoded.services/api/static/authorisation/v1/openapi.json) - [Authorisation API Reference](http://docs.encoded.services/authorisation-api-reference/v1) ## Guides - [APM JavaScript Library](http://docs.encoded.services/alternative-payment-methods/v1/apm-javascript-library): APM JavaScript Library - [Apple Pay](http://docs.encoded.services/alternative-payment-methods/v1/apple-pay): Apple Pay - [Google Pay](http://docs.encoded.services/alternative-payment-methods/v1/google-pay): Google Pay - [Quick Start](http://docs.encoded.services/guides/v1/quick-start): Quick Start - [Separate Authorisation and Capture](http://docs.encoded.services/payment-flows/v1/authorise-and-capture): Separate Authorisation and Capture - [Create a Payment Plan](http://docs.encoded.services/payment-flows/v1/create-a-payment-plan): Create a Payment Plan - [ECOM Payment with 3DS2 Challenge](http://docs.encoded.services/payment-flows/v1/ecom-3ds2-card-payment): ECOM Payment with 3DS2 Challenge - [Hosted Payment Fields Session](http://docs.encoded.services/payment-flows/v1/hosted-payment-fields-session): Hosted Payment Fields Session - [Hosted Payment Page with an Order](http://docs.encoded.services/payment-flows/v1/hosted-payment-page-order): Hosted Payment Page with an Order - [Stored Card Transaction](http://docs.encoded.services/payment-flows/v1/pay-with-a-token): Stored Card Transaction - [Generate and Send a PayByLink](http://docs.encoded.services/payment-flows/v1/paybylink): Generate and Send a PayByLink - [Refund a Payment](http://docs.encoded.services/payment-flows/v1/refund-a-payment): Refund a Payment - [Store a Card](http://docs.encoded.services/payment-flows/v1/save-a-card): Store a Card - [Processing a MOTO Payment](http://docs.encoded.services/payment-flows/v1/take-a-card-payment): Processing a MOTO Payment - [Void an Authorisation](http://docs.encoded.services/payment-flows/v1/void-an-authorisation): Void an Authorisation - [Collated & Grouped Transaction Data](http://docs.encoded.services/reporting/v1/collated-and-grouped-data): Collated & Grouped Transaction Data - [Customer and Order Summaries](http://docs.encoded.services/reporting/v1/customer-and-order-summaries): Customer and Order Summaries - [Reporting Filtering & Pagination](http://docs.encoded.services/reporting/v1/filtering-and-pagination): Reporting Filtering & Pagination - [Reporting Overview](http://docs.encoded.services/reporting/v1/overview): Reporting Overview - [Reporting Payment Plans](http://docs.encoded.services/reporting/v1/payment-plans): Reporting Payment Plans - [Reporting Transaction Summaries](http://docs.encoded.services/reporting/v1/transaction-summaries): Reporting Transaction Summaries - [Reporting URLs & Authentication](http://docs.encoded.services/reporting/v1/urls-and-authentication): Reporting URLs & Authentication - [Response Codes](http://docs.encoded.services/testing/v1/response-codes): Response Codes - [Testing](http://docs.encoded.services/testing/v1/testing): Testing ## Concepts - [API Object Model](http://docs.encoded.services/concepts/v1/api-object-model): API Object Model - [Authentication](http://docs.encoded.services/concepts/v1/authentication): Authentication - [Custom Domains](http://docs.encoded.services/concepts/v1/custom-domains): Custom Domains - [Customers](http://docs.encoded.services/concepts/v1/customers): Customers - [EMV 3-D Secure](http://docs.encoded.services/concepts/v1/emv-3d-secure): EMV 3-D Secure - [Environments and URLs](http://docs.encoded.services/concepts/v1/environments-and-urls): Environments and URLs - [Groups and Entities](http://docs.encoded.services/concepts/v1/groups-and-entities): Groups and Entities - [Hosted Payment Fields](http://docs.encoded.services/concepts/v1/hosted-payment-fields): Hosted Payment Fields - [Hosted Payment Pages](http://docs.encoded.services/concepts/v1/hosted-payment-pages): Hosted Payment Pages - [Merchant Accounts](http://docs.encoded.services/concepts/v1/merchant-accounts): Merchant Accounts - [Notification Callbacks](http://docs.encoded.services/concepts/v1/notification-callbacks): Notification Callbacks - [Orders](http://docs.encoded.services/concepts/v1/orders): Orders - [PayByLink](http://docs.encoded.services/concepts/v1/paybylink): PayByLink - [Payment Orchestration](http://docs.encoded.services/concepts/v1/payment-orchestration): Payment Orchestration - [Payment Plans](http://docs.encoded.services/concepts/v1/payment-plans): Payment Plans - [Payment Sources](http://docs.encoded.services/concepts/v1/payment-sources): Payment Sources - [Sessions](http://docs.encoded.services/concepts/v1/sessions): Sessions - [Tokens](http://docs.encoded.services/concepts/v1/tokens): Tokens - [Transaction Results](http://docs.encoded.services/concepts/v1/transaction-results): Transaction Results - [Transactions](http://docs.encoded.services/concepts/v1/transactions): Transactions ## Operations - [GET /merchantaccounts](http://docs.encoded.services/api-reference/v1?operation=get-merchantaccounts): List merchant accounts - [POST /merchantaccounts](http://docs.encoded.services/api-reference/v1?operation=post-merchantaccounts): Create a merchant account - [GET /merchantaccounts/{merchantAccountId}](http://docs.encoded.services/api-reference/v1?operation=get-merchantaccounts-merchantAccountId): Get a merchant account - [GET /decision-rule-set-groups](http://docs.encoded.services/api-reference/v1?operation=get-decision-rule-set-groups): List decision rule-set groups - [POST /decision-rule-set-groups](http://docs.encoded.services/api-reference/v1?operation=post-decision-rule-set-groups): Create a decision rule-set group - [PATCH /decision-rule-set-groups](http://docs.encoded.services/api-reference/v1?operation=patch-decision-rule-set-groups): Submit a decision rule-set group - [GET /action-schema/{type}](http://docs.encoded.services/api-reference/v1?operation=get-action-schema-type): Get an action schema - [POST /applepay/payment-session/generate](http://docs.encoded.services/api-reference/v1?operation=post-applepay-payment-session-generate): Generate an Apple Pay payment session - [GET /customers](http://docs.encoded.services/api-reference/v1?operation=get-customers): Returns a list of Customers - [POST /customers](http://docs.encoded.services/api-reference/v1?operation=post-customers): Create new customers. - [GET /customers/{customer_id}](http://docs.encoded.services/api-reference/v1?operation=get-customers-customer_id): Find a customer by ID. - [PUT /customers/{customer_id}](http://docs.encoded.services/api-reference/v1?operation=put-customers-customer_id): Update a customer. - [DELETE /customers/{customer_id}](http://docs.encoded.services/api-reference/v1?operation=delete-customers-customer_id): Delete a customer. - [POST /expresshpp](http://docs.encoded.services/api-reference/v1?operation=post-expresshpp): Creates a hosted payment page from a URL encoded form with all relevant data - [GET /customers/{customer_id}/tokens](http://docs.encoded.services/api-reference/v1?operation=get-customers-customer_id-tokens): Retrieve a list of customer's tokens. - [GET /customers/{customer_id}/tokens/{token_id}](http://docs.encoded.services/api-reference/v1?operation=get-customers-customer_id-tokens-token_id): Retrieve a specific token belonging to a customer. - [PATCH /customers/{customer_id}/tokens/{token_id}](http://docs.encoded.services/api-reference/v1?operation=patch-customers-customer_id-tokens-token_id): Update a token's attributes or expiry date. - [DELETE /customers/{customer_id}/tokens/{token_id}](http://docs.encoded.services/api-reference/v1?operation=delete-customers-customer_id-tokens-token_id): Delete a token - [POST /hpp/config/{access_level}](http://docs.encoded.services/api-reference/v1?operation=post-hpp-config-access_level): Set the user access level-wide configuration of Hosted Payment Pages - [GET /tokens](http://docs.encoded.services/api-reference/v1?operation=get-tokens): Retrieve a list of tokens. - [GET /tokens/{token_id}](http://docs.encoded.services/api-reference/v1?operation=get-tokens-token_id): Retrieve a specific token. - [PATCH /tokens/{token_id}](http://docs.encoded.services/api-reference/v1?operation=patch-tokens-token_id): Update a tokens attributes or expiry date. - [DELETE /tokens/{token_id}](http://docs.encoded.services/api-reference/v1?operation=delete-tokens-token_id): Delete a token - [GET /orders](http://docs.encoded.services/api-reference/v1?operation=get-orders): Returns a list of Orders - [POST /orders](http://docs.encoded.services/api-reference/v1?operation=post-orders): Inserts an array of provided Orders. - [GET /orders/{order_id}](http://docs.encoded.services/api-reference/v1?operation=get-orders-order_id): Find an order by ID. - [GET /orders/{order_id}/paybylinks](http://docs.encoded.services/api-reference/v1?operation=get-orders-order_id-paybylinks): List an order's PayByLinks - [POST /paybylinks](http://docs.encoded.services/api-reference/v1?operation=post-paybylinks): Create a PayByLink - [GET /paybylinks/{paybylink_id}](http://docs.encoded.services/api-reference/v1?operation=get-paybylinks-paybylink_id): Retrieve a PayByLink - [GET /paybylinks/{paybylink_id}/transactions](http://docs.encoded.services/api-reference/v1?operation=get-paybylinks-paybylink_id-transactions): List a PayByLink's transactions - [GET /paybylinks/{paybylink_id}/deliveries](http://docs.encoded.services/api-reference/v1?operation=get-paybylinks-paybylink_id-deliveries): List a PayByLink's delivery attempts - [POST /paybylinks/{paybylink_id}/deliveries](http://docs.encoded.services/api-reference/v1?operation=post-paybylinks-paybylink_id-deliveries): Deliver or resend a PayByLink - [POST /paybylinks/{paybylink_id}/cancel](http://docs.encoded.services/api-reference/v1?operation=post-paybylinks-paybylink_id-cancel): Cancel a PayByLink - [GET /orders/{order_id}/transactions](http://docs.encoded.services/api-reference/v1?operation=get-orders-order_id-transactions): Retrieve transactions for an order. - [DELETE /orders/{order_id}/hpp](http://docs.encoded.services/api-reference/v1?operation=delete-orders-order_id-hpp): Deactivate the hosted payment page for an order. - [GET /transactions](http://docs.encoded.services/api-reference/v1?operation=get-transactions): Returns a list of Transactions - [POST /transactions](http://docs.encoded.services/api-reference/v1?operation=post-transactions): Submit a new Transaction - [GET /transactions/{transaction_id}](http://docs.encoded.services/api-reference/v1?operation=get-transactions-transaction_id): Returns a Transaction - [GET /transactions/{transaction_id}/rule-logs](http://docs.encoded.services/api-reference/v1?operation=get-transactions-transaction_id-rule-logs): Returns decision rule execution logs for a Transaction - [POST /transactions/{transaction_id}/challenge/{challenge_id}](http://docs.encoded.services/api-reference/v1?operation=post-transactions-transaction_id-challenge-challenge_id): Complete a challenge - [POST /sessions](http://docs.encoded.services/api-reference/v1?operation=post-sessions): Start a new Session - [GET /sessions/{session_id}](http://docs.encoded.services/api-reference/v1?operation=get-sessions-session_id): Retrieve a session - [PATCH /sessions/{session_id}/fields/{field_name}](http://docs.encoded.services/api-reference/v1?operation=patch-sessions-session_id-fields-field_name): Update a session field - [GET /issuers/{issuer_iin}](http://docs.encoded.services/api-reference/v1?operation=get-issuers-issuer_iin): Retrieve an issuer and details on whether the resulting issuer is configured to be accepted - [POST /applepay/signing-requests](http://docs.encoded.services/api-reference/v1?operation=post-applepay-signing-requests): Generate an Apple Pay Payment Processing certificate signing request - [POST /applepay/certificates/{certificate_signing_request_id}](http://docs.encoded.services/api-reference/v1?operation=post-applepay-certificates-certificate_signing_request_id): Upload the Apple Pay Payment Processing public key certificate - [POST /plans](http://docs.encoded.services/api-reference/v1?operation=post-plans): Create a new Payment Plan - [GET /plans/{plan_id}](http://docs.encoded.services/api-reference/v1?operation=get-plans-plan_id): Retrieve a payment plan - [PATCH /plans/{plan_id}](http://docs.encoded.services/api-reference/v1?operation=patch-plans-plan_id): Update a payment plan - [DELETE /plans/{plan_id}](http://docs.encoded.services/api-reference/v1?operation=delete-plans-plan_id): Delete a payment plan - [GET /plans/{plan_id}/payments](http://docs.encoded.services/api-reference/v1?operation=get-plans-plan_id-payments): Retrieve all payments associated with a payment plan - [GET /transactions](http://docs.encoded.services/reporting-api-reference/v1?operation=get-transactions): Returns a data object for transactions of the given or default time period. - [GET /transactions/by/{grouping}](http://docs.encoded.services/reporting-api-reference/v1?operation=get-transactions-by-grouping): Returns a data object of transaction count and amount by the grouping - [GET /transactions-summary](http://docs.encoded.services/reporting-api-reference/v1?operation=get-transactions-summary): Returns a list of Transaction summary data for the given time period - [GET /customers-summary](http://docs.encoded.services/reporting-api-reference/v1?operation=get-customers-summary): Returns a list of Customer summary data for the given time period - [GET /orders-summary](http://docs.encoded.services/reporting-api-reference/v1?operation=get-orders-summary): Returns a list of Order summary data for the given time period - [GET /payment-plans](http://docs.encoded.services/reporting-api-reference/v1?operation=get-payment-plans): Returns a list of Payment Plan data for the given time period(s) - [GET /api/v1/groups/visibility](http://docs.encoded.services/authorisation-api-reference/v1?operation=get-api-v1-groups-visibility): Load a visible group and its immediate children - [GET /api/v1/permissions](http://docs.encoded.services/authorisation-api-reference/v1?operation=get-api-v1-permissions): Read the legacy customer/account/subscriber permissions hierarchy - [POST /oauth2/token](http://docs.encoded.services/authorisation-api-reference/v1?operation=post-oauth2-token): Request an OAuth access token - [POST /api/v1/token-exchange/preview](http://docs.encoded.services/authorisation-api-reference/v1?operation=post-api-v1-token-exchange-preview): Preview the exchange grants for a target APP