Authorization Request Events

The following events are triggered for authorization request-related activities. For detailed information about setting up webhooks, see Webhooks.

authorizationRequest.approved

Occurs when an AuthorizationRequest is approved. See Programmatic authorization of card use.

Example authorizationRequest.approved payload:

{
  "data": [
    {
      "id": "412",
      "type": "authorizationRequest.approved",
      "attributes": {
        "createdAt": "2021-06-24T08:10:08.081Z",
        "amount": 2000,
        "available": 2500,
        "status": "Approved",
        "approvedAmount": 2000,
        "partialApprovalAllowed": false,
        "merchant": {
          "name": "Merchant name",
          "type": "6012",
          "id": "311204598883"
        },
        "recurring": false,
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "authorizationRequest": {
          "data": {
            "id": "6",
            "type": "purchaseAuthorizationRequest"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        },
        "card": {
          "data": {
            "id": "7",
            "type": "card"
          }
        }
      }
    }
  ]
}

---

authorizationRequest.declined

Occurs when an AuthorizationRequest is declined. See Programmatic authorization of card use.

Example authorizationRequest.declined payload:

{
  "data": [
    {
      "id": "412",
      "type": "authorizationRequest.declined",
      "attributes": {
        "createdAt": "2021-06-24T08:10:08.081Z",
        "amount": 2000,
        "available": 1900,
        "status": "Declined",
        "declineReason": "InsufficientFunds",
        "partialApprovalAllowed": false,
        "merchant": {
          "name": "Merchant name",
          "type": "6012",
          "id": "311204598883"
        },
        "recurring": false,
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "authorizationRequest": {
          "data": {
            "id": "6",
            "type": "purchaseAuthorizationRequest"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        },
        "card": {
          "data": {
            "id": "7",
            "type": "card"
          }
        }
      }
    }
  ]
}

---

authorizationRequest.pending

Occurs when an AuthorizationRequest is pending approval. See Programmatic authorization of card use.

Example authorizationRequest.pending payload:

{
  "data": [
    {
      "id": "412",
      "type": "authorizationRequest.pending",
      "attributes": {
        "createdAt": "2021-06-24T08:10:08.081Z",
        "amount": 2000,
        "available": 150000,
        "status": "Pending",
        "partialApprovalAllowed": false,
        "merchant": {
          "name": "Merchant name",
          "type": "6012",
          "id": "311204598883"
        },
        "recurring": false,
        "ecommerce": true,
        "cardPresent": false,
        "direction": "Debit",
        "mustBeApproved": false,
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "authorizationRequest": {
          "data": {
            "id": "6",
            "type": "purchaseAuthorizationRequest"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        },
        "card": {
          "data": {
            "id": "7",
            "type": "card"
          }
        }
      }
    }
  ]
}