Skip to main content
POST
/
chargeAuthorization
/
pay
Make payments using charge authorizations
curl --request POST \
  --url https://rest.staging.nickel.com/chargeAuthorization/pay \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payments": [
    {
      "chargeAuthorizationId": "<string>",
      "paymentLinks": [
        {
          "paymentLinkId": "<string>",
          "withdrawalDate": "2023-12-25",
          "amountCents": 123
        }
      ]
    }
  ],
  "idempotencyKey": "<string>"
}
'
{
  "paymentLinks": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "url": "<string>",
      "dueDate": "<string>",
      "customerId": "<string>",
      "requestedAmountCents": 123,
      "completedAmountCents": 123,
      "paymentId": "<string>"
    }
  ],
  "errors": [
    {
      "paymentLinkId": "<string>",
      "paymentLinkName": "<string>",
      "error": "<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.

Body

application/json
payments
object[]
required

Array of charges to process

idempotencyKey
string

Response

Successful operation

Successfully processed payment links

errors
object[]

Payment links that failed to process