Skip to main content
GET
/
payment
/
{paymentId}
Returns a payment by id
curl --request GET \
  --url https://rest.staging.nickel.com/payment/{paymentId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "SUCCEEDED",
  "fees": [
    {
      "type": "CREDIT_CARD_FEE",
      "amountInCents": 290
    }
  ],
  "amountInCents": 10000,
  "chargedAmountInCents": 10290,
  "platformFeeInCents": 290,
  "paymentLinkId": "<string>",
  "paymentMethod": {
    "id": "<string>",
    "type": "ACH",
    "achDetails": {
      "bankName": "JP Morgan Chase",
      "routingNumber": "<string>",
      "accountNumberLastFour": "<string>"
    },
    "cardDetails": {
      "brand": "visa",
      "last4": "<string>",
      "holderName": "<string>",
      "expMonth": "2",
      "expYear": "2030"
    },
    "billingDetails": {
      "name": "<string>",
      "companyName": "<string>",
      "street": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "email": "<string>"
    }
  },
  "disbursement": {
    "id": "<string>",
    "status": "PENDING",
    "amountInCents": 10000,
    "bankName": "JP Morgan Chase",
    "accountNumberLastFour": "<string>",
    "paymentIds": [
      "clkqzo2y1000cx9tfohoiodq1"
    ],
    "createdAt": "2023-12-25",
    "paidAt": "2023-12-25"
  },
  "refunds": [
    {
      "id": "<string>",
      "amountCents": 515,
      "refundDate": "2023-11-07T05:31:56Z",
      "voided": true
    }
  ],
  "createdAt": 123,
  "estimatedDisbursementDate": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://dev.nickel.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

paymentId
string
required

ID of the payment

Response

Successful operation

id
string
status
string
Example:

"SUCCEEDED"

fees
object[]
amountInCents
integer<int64>
Example:

10000

chargedAmountInCents
integer<int64>
Example:

10290

platformFeeInCents
integer<int64>
Example:

290

paymentMethod
object
disbursement
object
refunds
object[]
createdAt
number
estimatedDisbursementDate
string | null