Card payments
Card management
13min
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 register with cross river apis the endpoints listed in this table are described in detail in the sections below action api call description card management docid\ m1 fwo7rozkip1glx3cdo post /api/card signs up a new payee card card management docid\ m1 fwo7rozkip1glx3cdo post /api/iframeconfiguration buildsignupcardurl renders an iframe into your website then, you can add the payee's card details into the frame card management docid\ m1 fwo7rozkip1glx3cdo post /api/v2/iframeconfiguration generateotcsignupcard returns the parameters you need to build an iframe web address (url) card management docid\ m1 fwo7rozkip1glx3cdo get /api/card returns details about payees' cards card management docid\ m1 fwo7rozkip1glx3cdo get /api/card/{cardtoken} returns a payee's card details card management docid\ m1 fwo7rozkip1glx3cdo put /api/card turn a payee's card on or off card management docid\ m1 fwo7rozkip1glx3cdo post /api/paymentinstrument signs up a wallet account add a card 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 overview supported by cross river set up an iframe on a merchant site 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 card management of generating iframe code generate an iframe otc signup card 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 set up iframe get card information 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 card management docid\ m1 fwo7rozkip1glx3cdo get card details by card token 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 card management docid\ m1 fwo7rozkip1glx3cdo deactivate or reactivate 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 card management docid\ m1 fwo7rozkip1glx3cdo add a payalias signs up a wallet account for the service also, checks whether a wallet account phone number matches a potential recipient or not related topics card payments ofac screening overview foreign exchange rates api references transaction management ofac foreign exchange rates request and response codes error codes tutorials originate a push transaction originate a pull transaction