Skip to main content
POST
/
customer
/
{customerId}
/
requestChargeAuthorization
Request charge authorization from a customer
curl --request POST \
  --url https://rest.staging.nickel.com/customer/{customerId}/requestChargeAuthorization \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sendEmail": true,
  "emails": [
    "<string>"
  ],
  "memo": "<string>",
  "transactionLimitCents": 123,
  "expirationDate": "2023-12-25",
  "paymentMethodTypes": [
    "ACH"
  ]
}
'
{
  "id": "<string>",
  "customerId": "<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>"
    }
  },
  "transactionLimitInCents": 123,
  "expiresAt": 123,
  "active": true,
  "url": "<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

customerId
string
required

ID of the customer that needs to be fetched

Body

application/json

Charge authorization request details. If emails are omitted, the customer's emails on file are used.

sendEmail
boolean
required
emails
string[]
memo
string | null
transactionLimitCents
integer<int64> | null
expirationDate
string<date> | null
paymentMethodTypes
enum<string>[]
Available options:
ACH,
CREDIT_CARD

Response

Successful operation

id
string
customerId
string
paymentMethod
object
transactionLimitInCents
integer<int64> | null
expiresAt
number | null

Expiration timestamp as epoch milliseconds

active
boolean
url
string | null