The /credit_card API calls

/credit_card

This call allows you to lookup the details of the a credit card that you have tokenized.

Arguments:

Example:

{
  "client_id":12345,
  "client_secret":"asbasf2341",
  "credit_card_id":235810395803
}

Response:

Example:

{
  "credit_card_id":235810395803,
  "credit_card_name":"MasterCard xxxxxx4769",
  "state":"new",
  "user_name":"Bob Smith",
  "email":"bob.smith@example.com",
  "create_time":1367958263,
  "input_source":"card_keyed",
  "virtual_terminal_mode":"none",
  "reference_id":"123abc",
  "expiration_month": 4,
  "expiration_year": 2020,
  "last_four": "4769"
}

/credit_card/create

This call allows you to pass credit card information and receive back a credit_card_id. You will then be able to use that credit_card_id on the /checkout/create call to execute a payment immediately with that credit card (similar to how the preapproval_id on /checkout/create works). Note that you will need to call the /checkout/create call or the /credit_card/authorize call within 30 minutes or the credit card object will expire.

Note: If you pass an access_token on this call, the credit card will be added to the user associated with that access_token. If you want to do a guest payment (ie the payer is not registered on WePay), then do not pass an access_token.

Note: User contact information (especially e-mail) is key for risk analysis, so please make sure you provide the actual end-user contact information.

Arguments:

Example:

{
  "client_id":187493,
  "user_name":"Bob Smith",
  "email":"test@example.com",
  "cc_number":"5496198584584769",
  "cvv":"123",
  "expiration_month":4,
  "expiration_year":2020,
  "address":
  {
    "address1":"test",
    "city":"test",
    "state":"CA",
    "country":"US",
    "zip":"94025"
  }
}

Response:

Example:

{
  "credit_card_id":235810395803,
  "state":"new"
}

/credit_card/authorize

You should only use this call if you are not going to immediately make the /checkout/create call with the credit_card_id. This call will authorize the card and let you use it at a later time or date (for crowdfunding, subscriptions, etc). If you don't call /credit_card/authorize or /checkout/create within 30 minutes then the credit card object will expire.

Arguments:

Example:

{
  "client_id":12345,
  "client_secret":"asbasf2341",
  "credit_card_id":235810395803
}

Response:

Example:

{
  "credit_card_id":235810395803,
  "credit_card_name":"MasterCard xxxxxx4769",
  "state":"new",
  "user_name":"Bob Smith",
  "email":"bob.smith@example.com",
  "create_time":1367958263,
  "input_source":"card_keyed",
  "virtual_terminal_mode":"none",
  "reference_id":"123abc"
}

/credit_card/find

Search through tokenized credit cards.

Arguments:

Example:

{
  "client_id":12345,
  "client_secret":"asbasf2341",
  "reference_id":"abc123"
}

Response:

An array of credit_cards matching the search parameters. Each element of the array will include the same data as returned from the /credit_card call.

/credit_card/modify

Make modifications to existing tokenized credit card.

Arguments:

Example:

{
  "client_id":12345,
  "client_secret":"asbasf2341",
  "credit_card_id":"1234567",
  "auto_update": true,
  "callback_uri": "http://www.example.com/ipn"
}

Response:

Same data as returned from the /credit_card call.

/credit_card/transfer

This call is similar to /credit_card/create. It is intended to be used server-server for the purpose of migrating credit card information to WePay. WePay automatically tests cards transferred to us via /credit_card/transfer by making a $0.00 authorization (in rare instances, the authorization amount may be $1.00 instead). All payment error codes (200X) are possible return values for /credit_card/transfer.

Arguments:

Response:

/credit_card/delete

Delete the credit card when you don't need it anymore. Note that you won't be able to use this card to make payments any more.

Arguments:

Example:

{
  "client_id":12345,
  "client_secret":"asbasf2341",
  "credit_card_id":235810395803
}

Response:

Example:

{
  "credit_card_id":235810395803,
  "state":"deleted"
}