Bind NP card to caas user

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Problem statement

Partners need a public API to bind an NP card to a business account or to a linked personal user.

Executive Summary

This endpoint exposes POST /v1/corporate-cards/bind.

It lets an authenticated partner bind a card to either:

  1. The business account.
  2. A linked personal user under that business account.

The request uses the card PAN and PIN, and the response returns the bound card details on success.

Integration model

ModeWhen to useRequired inputResult
Business bindBind the card to the business accountbusinessOrPersonal = Business, onBehalfOfUserId, fullPan, pinThe card is attached to the business account

Request details

The request body accepts four fields:

FieldRequiredDescription
businessOrPersonalYesBusiness
onBehalfOfUserIdNo, but required for personal bindingPersonal user ID to bind the card for.
fullPanYesFull primary account number of the card.
pinYesCard PIN.

If businessOrPersonal is Personal, the system validates that the personal user is linked to the business account. If that mapping does not exist, the request fails with 403 Forbidden.

The response returns the bound card object and standard API error fields.

Examples

Bind to the account

{
  "businessOrPersonal": "Business",
  "onBehalfOfUserId": "11111111-2222-3333-4444-555555555555",
  "fullPan": "4111111111110040",
  "pin": "1475"
}

Security

[!WARNING]
fullPan and pin are sensitive cardholder data. Send this request only over HTTPS and handle the payload according to your PCI DSS controls.


Timeout: 2 seconds.

Body Params
string
enum
required
Allowed:
uuid | null
string
required
length ≥ 1
string
required
length ≥ 1
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json