Skip to main content
Ready-to-LaunchCustom Builds
Start Building Now

Authorization Request Resources

This page documents the resources related to Authorization Requests. For the complete list of all resources, see Resources.

PurchaseAuthorizationRequest​

PurchaseAuthorizationRequest is a JSON:API resource representing a purchase authorization request. Top-level fields:

id
string
Identifier of the authorization request resource.
type
string
Type of the resource. The value is always purchaseAuthorizationRequest.
attributes
JSON Object
JSON object representing the authorization request data.
relationships
JSON:API Relationships
Describes relationships between the authorization request and other resources.

Attributes​

createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the authorization request.
status
string
The status of the authorization request.
partialApprovalAllowed
boolean
Whether partial approval is allowed.
merchant
object
Information about the merchant.
recurring
boolean
Whether this is a recurring authorization.
ecommerce
boolean
Whether this is an e-commerce transaction.
cardPresent
boolean
Whether the card was present.

Relationships​

account
JSON:API Relationship
The Deposit Account.
customer
JSON:API Relationship
The Customer.
card
JSON:API Relationship
The Card.
Example PurchaseAuthorizationRequest resource:
{
  "type": "purchaseAuthorizationRequest",
  "id": "1",
  "attributes": {
    "createdAt": "2021-06-24T08:10:08.081Z",
    "amount": 2000,
    "status": "Pending",
    "partialApprovalAllowed": false,
    "merchant": {
      "name": "Merchant name",
      "type": "6012",
      "id": "311204598883"
    },
    "recurring": false,
    "ecommerce": true,
    "cardPresent": false,
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "card": {
      "data": {
        "type": "card",
        "id": "7"
      }
    }
  }
}

CardTransactionAuthorizationRequest​

CardTransactionAuthorizationRequest is a JSON:API resource representing a card transaction authorization request. Top-level fields:

id
string
Identifier of the authorization request resource.
type
string
Type of the resource. The value is always cardTransactionAuthorizationRequest.
attributes
JSON Object
JSON object representing the authorization request data.
relationships
JSON:API Relationships
Describes relationships between the authorization request and other resources.

Attributes​

createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the authorization request.
status
string
The status of the authorization request.
partialApprovalAllowed
boolean
Whether partial approval is allowed.
merchant
object
Information about the merchant.
recurring
boolean
Whether this is a recurring authorization.
direction
string
The direction of the transaction (Credit or Debit).

Relationships​

account
JSON:API Relationship
The Deposit Account.
customer
JSON:API Relationship
The Customer.
card
JSON:API Relationship
The Card.
Example CardTransactionAuthorizationRequest resource:
{
  "type": "cardTransactionAuthorizationRequest",
  "id": "1",
  "attributes": {
    "createdAt": "2021-06-24T08:10:08.081Z",
    "amount": 2000,
    "status": "Pending",
    "partialApprovalAllowed": false,
    "merchant": {
      "name": "Merchant name",
      "type": "6012",
      "id": "311204598883"
    },
    "recurring": false,
    "direction": "Debit",
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "card": {
      "data": {
        "type": "card",
        "id": "7"
      }
    }
  }
}

AtmAuthorizationRequest​

AtmAuthorizationRequest is a JSON:API resource representing an ATM authorization request. Top-level fields:

id
string
Identifier of the authorization request resource.
type
string
Type of the resource. The value is always atmAuthorizationRequest.
attributes
JSON Object
JSON object representing the authorization request data.
relationships
JSON:API Relationships
Describes relationships between the authorization request and other resources.

Attributes​

createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the authorization request.
status
string
The status of the authorization request.
direction
string
The direction of the transaction (Credit or Debit).
atmName
string
The name of the ATM.
atmLocation
string
The location of the ATM.
surcharge
integer
The surcharge amount in cents.

Relationships​

account
JSON:API Relationship
The Deposit Account.
customer
JSON:API Relationship
The Customer.
card
JSON:API Relationship
The Card.
Example AtmAuthorizationRequest resource:
{
  "type": "atmAuthorizationRequest",
  "id": "1",
  "attributes": {
    "createdAt": "2021-06-24T08:10:08.081Z",
    "amount": 2000,
    "status": "Pending",
    "direction": "Debit",
    "atmName": "ATM Name",
    "atmLocation": "123 Main St",
    "surcharge": 250,
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "card": {
      "data": {
        "type": "card",
        "id": "7"
      }
    }
  }
}