Events

Retrieves events in sorted (by epoch) order

Changed on

Retrieves a list of events. They are returned in sorted (by epoch) order (default is newest first). You can query one of your sub-account's events buy using the Account header.

get/events

Request

  • Base URL
    https://sandbox-api.ryftpay.com/v1
  • URL
    https://sandbox-api.ryftpay.com/v1/events
  • Auth
    API key in header Authorization

Query parameters

ascendingboolean

Control the order (newest or oldest) in which the events are returned. false will arrange the results with newest first whereas true shows oldest first.

limitinteger
Example:20

Control how many items are returned in the result list. The max limit we allow is 50.

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this when you want to fetch events related to a linked account)

Response

Successfully retrieved a list of events

Example response

{
  "items": [
    {
      "id": "ev_01FGNPAY1DB5TKPB35M1MNT6PN",
      "eventType": "PaymentSession.captured",
      "data": {
        "id": "ps_01FCTS1XMKH9FF43CAFA4CXT3P",
        "amount": 500,
        "currency": "GBP",
        "paymentType": "Standard",
        "entryMode": "Online",
        "customerEmail": "example@mail.com",
        "customerDetails": {
          "id": "cus_01G0EYVFR02KBBVE2YWQ8AKMGJ",
          "firstName": "Fred",
          "lastName": "Jones",
          "homePhoneNumber": "+447900000000",
          "mobilePhoneNumber": "+447900000000",
          "metadata": {
            "customerId": "123"
          }
        },
        "credentialOnFileUsage": {
          "initiator": "Customer",
          "sequence": "Initial"
        },
        "previousPayment": {
          "id": "ps_01G0EYVFR02KBBVE2YWQ8AKMGJ"
        },
        "rebillingDetail": {
          "amountVariance": "Fixed",
          "numberOfDaysBetweenPayments": 30,
          "totalNumberOfPayments": 12,
          "currentPaymentNumber": 1,
          "expiry": 1776988800
        },
        "paymentMethod": {
          "type": "Card",
          "tokenizedDetails": {
            "id": "pmt_01G0EYVFR02KBBVE2YWQ8AKMGJ",
            "stored": true
          },
          "card": {
            "scheme": "Mastercard",
            "last4": "4242",
            "binDetails": {
              "issuer": "Ryft Bank Ltd",
              "issuerCountry": "GB",
              "fundingType": "Debit",
              "productType": "Consumer"
            }
          },
          "wallet": {
            "type": "ApplePay"
          },
          "billingAddress": {
            "firstName": "Nathan",
            "lastName": "Jones",
            "lineOne": "123 Test Street",
            "lineTwo": "456 Lane",
            "city": "Manchester",
            "country": "GB",
            "postalCode": "SP4 7DE",
            "region": "NY"
          },
          "checks": {
            "avsResponseCode": "Y",
            "cvvResponseCode": "M"
          }
        },
        "platformFee": 50,
        "splitPaymentDetail": {
          "items": [
            {
              "id": "sp_01FCTS1XMKH9FF43CAFA4CXT3P",
              "accountId": "ac_b83f2653-06d7-44a9-a548-5825e8186004",
              "amount": 50,
              "fee": {
                "amount": 50
              },
              "description": "2 x The Selfish Gene",
              "metadata": {
                "productId": "123",
                "productDescription": "The Selfish Gene"
              }
            }
          ]
        },
        "status": "PendingPayment",
        "metadata": {
          "orderNumber": "123"
        },
        "clientSecret": "ps_01FCTS1XMKH9FF43CAFA4CXT3P_secret_b83f2653-06d7-44a9-a548-5825e8186004",
        "lastError": "insufficient_funds",
        "refundedAmount": 120,
        "statementDescriptor": {
          "descriptor": "Ryft Ltd",
          "city": "London"
        },
        "requiredAction": {
          "type": "Redirect",
          "url": "https://ryftpay.com/3ds-auth"
        },
        "returnUrl": "https://ryftpay.com/checkout?orderId=123&ps=ps_01FCTS1XMKH9FF43CAFA4CXT3P",
        "authorizationType": "FinalAuth",
        "captureFlow": "Automatic",
        "shippingDetails": {
          "address": {
            "firstName": "Fox",
            "lastName": "Mulder",
            "lineOne": "Stonehenge",
            "postalCode": "SP4 7DE",
            "city": "Salisbury",
            "country": "GB"
          }
        },
        "orderDetails": {
          "reference": "fffd1682-f82b-43e3-a89b-48d9ad7d55d9",
          "items": [
            {
              "reference": "product123",
              "name": "The Big Gundown (Blu-ray)",
              "quantity": 2,
              "unitPrice": 250,
              "taxAmount": 50,
              "totalAmount": 540,
              "discountAmount": 10
            }
          ]
        },
        "paymentSettings": {
          "platform": {
            "paymentFees": {
              "interchange": {
                "bookTo": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
              },
              "network": {
                "bookTo": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
              },
              "miscPassThrough": {
                "bookTo": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
              }
            }
          },
          "threeDs": {
            "challengeIndicator": "NoPreference",
            "policy": "Required"
          }
        },
        "createdTimestamp": 1470989538,
        "lastUpdatedTimestamp": 1470989538
      },
      "endpoints": [
        {
          "webhookId": "wh_31fba123-0fef-41d6-92ad-fd7089f49f8a",
          "acknowledged": true,
          "attempts": 2
        }
      ],
      "accountId": "ac_b83f2653-06d7-44a9-a548-5825e8186004",
      "createdTimestamp": 1570989538
    }
  ]
}

Changes

    • warning

      added the new 3ds_authentication_not_supported enum value to the /////// response property for the response status

    • warning

      added the new 3ds_authentication_not_supported enum value to the ///////// response property for the response status

    • warning

      added the new authorisation_denied enum value to the /////// response property for the response status

    • warning

      added the new authorisation_denied enum value to the ///////// response property for the response status

    • warning

      added the new in_person_terminal_action_cancelled enum value to the /////// response property for the response status

    • warning

      added the new in_person_terminal_action_cancelled enum value to the ///////// response property for the response status

    • warning

      added the new in_person_terminal_action_timeout enum value to the /////// response property for the response status

    • warning

      added the new in_person_terminal_action_timeout enum value to the ///////// response property for the response status

    • warning

      added the new in_person_terminal_busy enum value to the /////// response property for the response status

    • warning

      added the new in_person_terminal_busy enum value to the ///////// response property for the response status

    • warning

      added the new in_person_terminal_not_available enum value to the /////// response property for the response status

    • warning

      added the new in_person_terminal_not_available enum value to the ///////// response property for the response status

    • warning

      added the new payment_cancelled enum value to the /////// response property for the response status

    • warning

      added the new payment_cancelled enum value to the ///////// response property for the response status

    • warning

      added the new recurring_series_terminated enum value to the /////// response property for the response status

    • warning

      added the new recurring_series_terminated enum value to the ///////// response property for the response status

    • info

      added the optional property /////// to the response with the status