Tribe Payments Gateway Credit Card API (v3) for merchants processing credit and debit card e-commerce (ECOM) transactions - sale, authorization, capture, refund, and void - organized around REST with JSON. Card-transaction and callback specifications harvested verbatim from the Tribe developer portal.
Payment Gateway - Credit Card API is one of 15 APIs that Tribe Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments, Payment Gateway, Card Payments, E-commerce, and United Kingdom. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
11 operations
across 11 paths,
organized into 11 resource areas,
and defines 67 schemas.
It is described by OpenAPI 3.0.0, at version 3.0.0.
Requests are made against a single base URL, http://127.0.0.1:10010/v3.
11 operations11 paths67 schemas11 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
3.0.0
Server
http://127.0.0.1:10010/v3
Authentication
API Key, API Key
Resource Areas
11
Authentication & Security 2
Payment Gateway - Credit Card API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-auth-account-id (accountId).
An API key is passed in the header as x-auth-account-password (accountPassword).
By default, every request must be authenticated.
Paths & Operations 11
Across 11 paths, the API surfaces 11 operations — 11 POST. They span 11 resource areas, including Sale, Authorize, Pre authorize, Credit, Process, P2P, Cancel, Cancel recurring, and 3 more. Each is listed below with its method, path, parameters, and response codes.
Sale 1
POST
/sale
postsalebody→ 202400401403
Authorize 1
POST
/authorize
postauthorizebody→ 202400401403
Pre authorize 1
POST
/pre-authorize
postpre-authorizebody→ 202400401403
Credit 1
POST
/credit
postcreditbody→ 202400401403
Process 1
POST
/process
postprocessbody→ 202400401403
P2P 1
POST
/p2p
postp2pbody→ 202400401403
Cancel 1
POST
/cancel
postcancelbody→ 202400401403
Cancel recurring 1
POST
/cancel-recurring
postcancel-recurringbody→ 202400401403
Capture 1
POST
/capture
postcapturebody→ 202400401403
Incremental authorize 1
POST
/incremental-authorize
postincremental-authorizebody→ 202400401403
Refund 1
POST
/refund
postrefundbody→ 202400401403
Schemas 67
The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are SaleTransaction (14 properties), AuthorizeTransaction (14 properties), SaleCustomer (10 properties), AuthorizeCustomer (10 properties). Each schema is shown below with its type and property counts.
Sale
object
5 properties
SaleTransaction
object
Object containing data of the Sale transaction
14 properties4 required
SaleCard
object
Object containing the Sale transaction card details
5 properties4 required
SaleShippingLocation
object
Object containing the Sale transaction shipping location data
5 properties
SaleCustomer
object
Object containing the Sale customer data
10 properties1 required
SaleRecurring
object
Object containing data of the recurring Sale payment
3 properties
responseSuccess
object
1 property
responseError
object
3 properties
responseErrorReport
object
3 properties
responseErrorDisputes
object
3 properties
responseErrorProcessing
object
3 properties
responseErrorTransactions
object
3 properties
responseUnauthorized
object
3 properties
responseForbidden
object
3 properties
responseTooManyRequests
object
3 properties
violationObjectProcessing
object
2 properties
violationObjectTransactions
object
2 properties
violationObjectDisputes
object
3 properties
violationObjectReport
object
2 properties
violationObjectForbidden
object
2 properties
unprocessableContent
object
2 properties
violationObjectTooManyRequests
object
2 properties
violationObject
object
3 properties
Authorize
object
5 properties
AuthorizeTransaction
object
Object containing data of the Authorize transaction
14 properties4 required
AuthorizeCard
object
Object containing the Authorize transaction card details
5 properties4 required
AuthorizeShippingLocation
object
Object containing the Authorize transaction shipping location data
5 properties
AuthorizeCustomer
object
Object containing data of the customer to be authorized
10 properties1 required
AuthorizeRecurring
object
Object containing data of the recurring payment to be authorized
3 properties
PreAuthorize
object
5 properties
PreAuthorizeTransaction
object
Object containing data of the Pre Authorize transaction
10 properties4 required
PreAuthorizeCard
object
Object containing the Pre Authorize transaction card details
5 properties4 required
PreAuthorizeShippingLocation
object
Object containing the Pre Authorize transaction shipping location data
5 properties
PreAuthorizeCustomer
object
Object containing data of the customer to be pre authorized
10 properties1 required
PreAuthorizeRecurring
object
1 property
Credit
object
4 properties
CreditTransaction
object
Object containing data of the Credit transaction
5 properties3 required
CreditCard
object
Object containing details of the card to be credited
5 properties4 required
CreditCustomer
object
Object containing data of the actual credit customer, i.e. the person or institution initiating a Credit transaction
10 properties
CreditReceiver
object
Object containing data of the funds receiver, i.e. the person or institution receiving a Credit
2 properties
Process
object
6 properties1 required
ProcessTransaction
object
Object containing data for the transaction
10 properties4 required
ProcessCard
object
Object containing the transaction card details
2 properties1 required
ProcessShippingLocation
object
Object containing the transaction shipping location data
5 properties
ProcessCustomer
object
Object containing data of the actual transaction customer
10 properties
ProcessReceiver
object
Object containing data of the transaction receiver
2 properties
P2p
object
6 properties
P2pTransaction
object
Object containing data of the P2P transaction
8 properties5 required
P2pCard
object
Object containing the P2P transaction card details
6 properties3 required
P2pShippingLocation
object
Object containing the P2P transaction shipping location data
5 properties
P2pCustomer
object
Object containing data of the actual P2P transaction customer
4 properties1 required
P2pReceiver
object
Object containing data of the P2P transaction receiver, i.e. the person or institution receiving funds
10 properties1 required
P2pReceiverLocation
object
Object containing the P2P transaction receiver location data
5 properties1 required
P2pReceiverIdentification
object
Object containing the P2P transaction receiver identification data
4 properties
P2pSender
object
Object containing data of the P2P transaction sender, i.e. the person or institution initiating a P2P transaction
9 properties2 required
P2pSenderLocation
object
5 properties4 required
P2pSenderIdentification
object
4 properties
Cancel
object
1 property
CancelTransaction
object
Object containing data of the transaction to be canceled
2 properties2 required
CancelRecurring
object
1 property
CancelRecurringTransaction
object
Object containing data of the recurring transaction to be canceled
1 property1 required
Capture
object
1 property
CaptureTransaction
object
Object containing data of the transaction to be captured
2 properties2 required
IncrementalAuthorize
object
1 property
IncrementalAuthorizeTransaction
object
Object containing data of the Incremental authorize transaction
2 properties2 required
Refund
object
1 property
RefundTransaction
object
Object containing data of the transaction to be refunded
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
