Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Payments

Get payment by ID

Find a Payment from a given ID.

get/payment/payments/{paymentId}

Path parameters

paymentIdstring uuid required

Identifier of the resource in Payrails.

Query parameters

includeInstrumentboolean

Boolean indicating if the payment instrument should be included in the response.

includePaymentTokenboolean

Boolean indicating if the instrument payment token should be included in the response.

includeProviderAccountDisplayNameboolean

Boolean indicating if the provider account display name should be included in the response.

includeHolderReferenceboolean

Boolean indicating if the holder reference should be included in the response.

Response

Payment entity found, and all details are included.

idstring uuid required

Unique identifier of the Payment in Payrails.

status'Created' | 'Pending' | 'Unknown' | 'Failed' | 'Expired' | 'Preauthorized' | 'Authorized' | 'Canceled' | 'Captured' | 'Refunded' required

Current status of the Payment in Payrails. More information can be found here.

createdAtstring date-time

Exact date and time when the Payment was created in Payrails. Possibly differs slightly from the date in the PSP.

providerIdstring uuid

Unique identifier of the Provider that was used to process the Payment.

paymentMethodTypestring

Type of payment method used to process the payment.

providerIntegrationTypestring

Type of integration used to process the payment (in case the payment provider supports multiple).

providerNamestring

Name of the Provider that was used to process the Payment, e.g. Adyen, Checkout, Stripe.

providerReferencestring

Unique identifier of the Payment in an external system, e.g. PSP.

providerConfigIdstring uuid

Unique identifier of the merchant-specific Provider Configuration that was used to process the Payment. This can include the set of credentials used, the merchant account, country, vertical, etc.

holderIdstring uuid

Unique identifier of the Holder that is involved in the Payment.

instrumentIdstring uuid

Unique identifier of the Instrument that was used for the Payment in Payrails.

instrumentTokenIdstring uuid

Unique identifier of the specific Token inside the Instrument used for the Payment in Payrails.

transactionReferencestring

Merchant-specific identifier of the execution. This can be used for searching for the Payment later.

transactionElementReferencestring

Identifier of the step in the Workflow that led to this Payment.

pspRedirectUrlstring

In case a redirection process is needed during the Payment, this is the URL where the PSP requested Payrails to redirect the user to.

merchantReturnUrlstring

In case a redirection process is needed during the Payment, Payrails will return to this merchant-specific URL after it finished.

merchantReferencestring

Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.

providerAccountDisplayNamestring

Display name of the Provider Account/Configuration that was used to process the Payment.

providerDisplayNamestring

Display name of the Provider that was used to process the Payment.

workspaceIdstring

Workspace ID that the Payment belongs to.

Example response

{
  "amount": {
    "value": "12.50",
    "currency": "EUR"
  },
  "instrument": {
    "data": {
      "bin": "416598",
      "binLookup": {
        "bin": "416598"
      }
    }
  },
  "capturedAmount": {
    "value": "12.50",
    "currency": "EUR"
  },
  "refundedAmount": {
    "value": "12.50",
    "currency": "EUR"
  },
  "meta": {
    "order": {
      "storeId": "store-123",
      "reference": "order_3573894940903",
      "placement": {
        "country": {
          "code": "DE"
        },
        "city": "Berlin"
      },
      "deliveryAddress": {
        "city": "Ankeborg",
        "country": {
          "code": "SE"
        },
        "doorNumber": "1",
        "street": "Stargatan",
        "postalCode": "12345",
        "name": "Peter",
        "lastName": "Parker",
        "email": "notbatman@gmail.com"
      },
      "billingAddress": {
        "city": "Ankeborg",
        "country": {
          "code": "SE"
        },
        "doorNumber": "1",
        "street": "Stargatan",
        "postalCode": "12345",
        "name": "Bruno",
        "lastName": "Diaz",
        "email": "iambatman@gmail.com"
      },
      "lines": [
        {
          "id": "123",
          "quantity": 1,
          "taxPercentage": {
            "value": "5"
          },
          "description": "Delicious Beer.",
          "name": "Beer 1",
          "total": {
            "value": "100",
            "currency": "SEK"
          },
          "links": {
            "productUrl": "https://www.amazingmerchant.com/products/1",
            "imageUrl": "https://www.amazingmerchant.com/products/1.jpeg"
          }
        }
      ]
    },
    "customer": {
      "reference": "1231905323475",
      "name": "FirstName",
      "lastName": "LastName",
      "email": "someone@email.com",
      "type": "VIP",
      "country": {
        "code": "SE"
      }
    },
    "clientContext": {
      "ipAddress": "217.110.239.132",
      "osType": "ios",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
      "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
      "language": "nl_NL",
      "colorDepth": 24,
      "screenHeight": 723,
      "screenWidth": 1536,
      "timeZoneOffset": 0,
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "cookiesAccepted": true,
      "origin": "https://merchant.com/checkout",
      "host": "merchant.com"
    },
    "vendor": {
      "reference": "vendor-123",
      "name": "Cool Restaurant"
    },
    "risk": {
      "score": "80",
      "skipPaymentProviderRules": false,
      "force3DS": true,
      "threeDSMode": "Default",
      "allowNative3DS": true,
      "sessionId": "34567890123",
      "exemptionIndicator": "lowValue"
    },
    "subscription": {
      "chargeFrequency": "P2D",
      "expiration": "2000-09-01"
    },
    "tags": {
      "customKey": "customValue"
    }
  },
  "history": [
    {
      "amount": {
        "value": "12.50",
        "currency": "EUR"
      }
    }
  ]
}