Skip to main content
GET
/
api
/
v1
/
payments
/
{id}
Get payment
curl --request GET \
  --url https://payments.coinbase.com/api/v1/payments/{id} \
  --header 'Authorization: <api-key>'
{
  "payment": {
    "entity": "<string>",
    "id": "<string>",
    "maxAmount": "<string>",
    "token": "<string>",
    "networkId": 123,
    "payer": "<string>",
    "signature": "<string>",
    "receiver": "<string>",
    "maxFeeBps": 123,
    "minFeeBps": 123,
    "feeReceiver": "<string>",
    "salt": "<string>",
    "paymentInfoHash": "<string>",
    "nonce": "<string>",
    "authorizationExpiry": "<string>",
    "preApprovalExpiry": "<string>",
    "refundExpiry": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "operator": "<string>",
    "contractAddress": "<string>",
    "authorizedAmount": "<string>",
    "capturedAmount": "<string>",
    "voidedAmount": "<string>",
    "refundedAmount": "<string>",
    "chargedAmount": "<string>",
    "merchantId": "<string>"
  },
  "paymentOperations": [
    {
      "entity": "<string>",
      "id": "<string>",
      "transactionHash": "<string>",
      "params": {},
      "status": "PAYMENT_OPERATION_STATUS_SUCCEEDED",
      "action": "PAYMENT_OPERATION_ACTION_AUTHORIZE",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "payment": {
        "entity": "<string>",
        "id": "<string>",
        "maxAmount": "<string>",
        "token": "<string>",
        "networkId": 123,
        "payer": "<string>",
        "signature": "<string>",
        "receiver": "<string>",
        "maxFeeBps": 123,
        "minFeeBps": 123,
        "feeReceiver": "<string>",
        "salt": "<string>",
        "paymentInfoHash": "<string>",
        "nonce": "<string>",
        "authorizationExpiry": "<string>",
        "preApprovalExpiry": "<string>",
        "refundExpiry": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "operator": "<string>",
        "contractAddress": "<string>",
        "authorizedAmount": "<string>",
        "capturedAmount": "<string>",
        "voidedAmount": "<string>",
        "refundedAmount": "<string>",
        "chargedAmount": "<string>",
        "merchantId": "<string>"
      },
      "output": "<string>",
      "error": "<string>",
      "errorCode": "<string>",
      "revertReason": "<string>",
      "blockNumber": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authorization header using the Bearer scheme. Learn more about JWT tokens in the Coinbase Developer Portal.

Path Parameters

​
id
string
required

The ID of the payment.

Response

A successful response.

​
payment
Payment · object

Payment details including identifiers, amounts, and blockchain transaction data.

Example:
{
  "entity": "payment",
  "id": "payment123",
  "maxAmount": "100.00",
  "token": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
  "networkId": 8453,
  "payer": "0xpayer",
  "signature": "0xsig",
  "receiver": "0xreceiver",
  "minFeeBps": 50,
  "maxFeeBps": 50,
  "feeReceiver": "0xcccccccccccccccccccccccccccccccccccccccc",
  "salt": "2334324235415445346745646",
  "paymentInfoHash": "2334324235415445346745646",
  "nonce": "2334324235415445346745646",
  "authorizationExpiry": 1843954582,
  "preApprovalExpiry": 0,
  "refundExpiry": 1843954582,
  "createdAt": "2024-03-20T00:00:00.000Z",
  "updatedAt": "2024-03-20T00:00:00.000Z",
  "operator": "0xoperator",
  "contractAddress": "0xcontract",
  "authorizedAmount": "50.00",
  "capturedAmount": "50.00",
  "voidedAmount": "0.00",
  "refundedAmount": "0.00",
  "chargedAmount": "50.00"
}
​
paymentOperations
PaymentOperation · object[]

List of payment operations associated with the payment. Only returned when authenticated as the operator that owns this payment.