NodeRings Docs

Get Payment

GetPayment retrieves a single payment with refunds

GET
/v1/payments/{paymentId}

Authorization

Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Path Parameters

paymentIdstring

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/payments/{paymentId}" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "payment": {
    "id": "string",
    "invoiceId": "string",
    "paymentMethodId": "string",
    "paymentStatus": "PAYMENT_STATUS_UNSPECIFIED",
    "amount": "string",
    "currency": "string",
    "transactionId": "string",
    "paymentProvider": "string",
    "failureReason": "string",
    "failureCode": "string",
    "processedAt": "2019-08-24T14:15:22Z",
    "refundAmount": "string",
    "refundReason": "string",
    "refundedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "status": "STATUS_UNSPECIFIED",
    "timestamps": {
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z"
    }
  },
  "refunds": [
    {
      "id": "string",
      "paymentId": "string",
      "refundStatus": "REFUND_STATUS_UNSPECIFIED",
      "amount": "string",
      "currency": "string",
      "providerRefundId": "string",
      "paymentProvider": "string",
      "failureReason": "string",
      "processedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "status": "STATUS_UNSPECIFIED",
      "timestamps": {
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      }
    }
  ]
}

Set Default Payment Method POST

Set a payment method as the default payment method Validates payment method belongs to organization/subscription

List Payments GET

ListPayments lists payments for an invoice or organization