Card management
Use Cross River card management APIs to sign up a new payee card, find out details about a payee card, and to activate or deactivate a card.
Get started with Cross River APIs.
The endpoints listed in this table are described in detail in the sections below.
Action | API Call | Description |
POST /api/Card | Signs up a new payee card | |
POST /api/iFrameConfiguration BuildSignupCardUrl | Renders an iFrame into your website. Then, you can add the payee's card details into the frame. | |
POST /api/iFrameConfiguration GenerateOtcSignupCard | Returns the parameters you need to build an iFrame web address (URL). | |
GET /api/Card | Returns details about payees' cards | |
GET /api/Card/{cardToken} | Returns a payee's card details | |
PUT /api/Card | Turn a payee's card on or off | |
POST /api/PaymentInstrument | Signs up a wallet account |
Signs up a new consumer payment card to the merchant's account.
When you call this endpoint, the card payments API stores the card number and returns a token. The API uses the token to identify the card, in place of the actual card number. Tokens provide a security measure to help prevent criminals from accessing card numbers.
This API call triggers Account name inquiry (ANI) and Address verification (AVS). These are fraud and risk detection services supported by Cross River.
Makes an iFrame display on your merchant website. Once the iFrame is added, you can enter payee card information directly into the iFrame.
IMPORTANT This function will be deprecated. See the template-based way of generating iFrame code.
Returns the parameters you need to build an iFrame web address (URL). This endpoint generates the iFrame code snippet dynamically. It does this based on a merchant's specific template and card payments environment. The OTC is a one-time code.
For details on how to customize and embed an iFrame into your merchant website, see the iFrame instructions .
Returns information about payment cards of consumers signed up to the merchant's account.
Add query parameters to filter the response the API returns to all GET calls.
Use pagination to control presentation of your results.
Response attributes
The response attributes for this call are the same as for Add a card.
Returns the parameter values defining a card authorized for transactions with a merchant partner. You get card details using the cardToken attribute.
Response attributes
The response attributes for this call are the same as for Add a card.
Deactivates a consumer's payment card, for instance, if the card is lost or stolen. Reactivates the card, for example, if the card is found.
Response attributes
The response attributes for this call are the same as for Add a card.
Signs up a wallet account for the service. Also, checks whether a wallet account phone number matches a potential recipient or not.