Sign in
Gateway Operations

Find one Gateway Operation

Retrieve a Gateway Operation by its ID

get/gateway-operations/{id}

Path parameters

idstring required

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the gateway operation

type'authorize' | 'capture' | 'refund' | 'void' | 'confirm' | 'create_apple_pay_session' | 'process_webhook' required

The type of operation performed against the payment service provider

status'pending' | 'completed' required

Current status of the gateway operation

amountnumber nullable required

Operation amount in minor currency units (e.g., 1500 for $15.00)

currency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk' | 'null' nullable required

Currency of the operation

processorIdstring nullable

The external identifier returned by the payment service provider. Only available from the dashboard.

transactionstring nullable required

The ID of the transaction this operation belongs to

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "authorize",
  "status": "completed",
  "amount": 1500,
  "currency": "usd",
  "processorId": "ch_1J8lZpJ9j1bSv2Jr6sVjXZ1N"
}

Changes

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