Skip to main content
GET
/
payment
/
{paymentId}
Returns a payment by id
curl --request GET \
  --url https://virtserver.swaggerhub.com/nickel-ace/apiv1/1.0.0/payment/{paymentId}
{
  "id": "<string>",
  "status": "SUCCEEDED",
  "fees": [
    {
      "feeType": "Credit Card Fee",
      "amountCents": 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>",
      "countryCode": "<string>"
    }
  },
  "disbursement": {
    "id": "<string>",
    "status": "PENDING",
    "amountInCents": 10000,
    "bankName": "JP Morgan Chase",
    "accountNumberLastFour": "<string>",
    "paymentIds": [
      "clkqzo2y1000cx9tfohoiodq1"
    ]
  },
  "refunds": [
    {
      "id": "<string>",
      "amountCents": 515,
      "refundDate": "2023-12-25",
      "void": true
    }
  ]
}

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[]