GEgetpaid
Payments

Get a payment

Retrieve a payment.

get/v2/payments/{payment_id}

Request

Path parameters

payment_idstring id required

The unique identifier of the payment.

Example:pay_4a4m2pjycdb1jbj68h1rvk9kcz

Response

OK

idstring id required

The unique identifier of the payment.

status'initiated' | 'action_required' | 'submitted' | 'authorized' | 'captured' | 'declined' | 'failed' | 'partially_refunded' | 'refunded' required

The status of the payment. See the list, transitions, and description of each status for more details.

referencestring required

An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.

created_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

updated_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

estimated_update_beforestring date-time-offset

Date-time with time zone offset in ISO 8601 format without second fractions (RFC 9557).

amountinteger required

The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).

currencystring currency required

The processing currency code according to the ISO-4217 standard

descriptionstring

A description of the checkout session only if the payment was part of a checkout. This will be visible to the buyer in the payment page but not in the bank or card statement.

statement_descriptorstring

The final statement descriptor shown on the buyer statement.

This value is calculated per payment method:

  • Cards: dynamic_descriptor with the GPD* prefix.
  • SEPA Direct Debit: remittance_info.

Example response

{
  "id": "pay_4a4m2pjycdb1jbj68h1rvk9kcz",
  "reference": "ORD-202510-0232",
  "created_at": "2025-09-01T22:05:48.479Z",
  "updated_at": "2025-09-01T22:05:48.479Z",
  "estimated_update_before": "2025-09-01T22:05:48-08:00",
  "amount": 1000,
  "currency": "EUR",
  "description": "Order 202510-0232",
  "statement_descriptor": "GPD*TITAN*202510-0232",
  "origin": {
    "id": "cko_4kf9v6xp00hzc99rdwr5m97wce"
  },
  "method": {
    "dynamic_descriptor": "TITAN*202510-0232",
    "card": {
      "holder_name": "Jane Doe",
      "first_digits": "424242",
      "last_digits": "4242",
      "expiry_month": 12,
      "expiry_year": 2025,
      "kind": "credit",
      "segment": "consumer"
    }
  },
  "splits": {
    "accounts": [
      {
        "id": "acc_44678r08jtm8zbt227tzhc4nw5",
        "version": "2",
        "split": {
          "amount": 1000
        },
        "processing_fee": {
          "percentage": 100,
          "amount": 1000
        }
      }
    ]
  },
  "standing_instruction": {
    "id": "sti_4tbftjwzxja1h71nzas1g0g1xm",
    "first": {
      "id": "pay_4a4m2pjycdb1jbj68h1rvk9kcz"
    }
  },
  "refunds": [
    {
      "id": "rfd_4a4m2pjycdb1jbj68h1rvk9kcz",
      "reference": "ORD-202510-0232",
      "created_at": "2025-09-01T22:05:48.479Z",
      "updated_at": "2025-09-01T22:05:48.479Z",
      "amount": 1000
    }
  ],
  "totals": {
    "net": 1000,
    "captured": 1000,
    "refunded": 1000,
    "refundable": 1000,
    "processing_fees": 1000,
    "accounts": [
      {
        "id": "acc_44678r08jtm8zbt227tzhc4nw5",
        "version": "2",
        "net": 1000,
        "captured": 1000,
        "refunded": 1000,
        "refundable": 1000,
        "processing_fees": 1000
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.