WePay logo
      Nothing Found

Update a payment method

post/payment_methods/{id}

The POST /payment_methods/{id} call allows your platform to update and add custom data to an existing payment method. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters

ID of the payment method, generated by WePay when the payment method is created.

header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
Request Body schema: application/json
object or null

Credit card structure to be used for updating credit card information.

object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

object or null

Payment bank structure to be used for updating payment bank information. No field is allowed for update now.

Array of objects or null

Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects.

type
string
Enum: Description
credit_card

This value is required if the credit_card structure is being sent with raw credit card data.

payment_bank_us

This value is required if the payment_bank_us structure is being sent with the raw bank account data.

… 1 more
Responses
200
Response Schema: application/json
id
required
string

ID of the payment method, generated by WePay when the payment method is created.

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
payment_methods
path
required
string

Path of resource and resource ID.

required
object

Details the owner resource and owner path.

create_time
required
integer <int64> >= 0
type
required
string

Type of payment method.

Enum: Description
credit_card

This value is required if the credit_card structure is being sent with raw credit card data.

payment_bank_us

This value is required if the payment_bank_us structure is being sent with the raw bank account data.

… 4 more
status
required
string

Possible values include: deleted, unverified, verification_failed, verified.

Enum: Description
unverified

This payment method has not been verified yet and cannot be used to create payments until the status updates to verified.

verified

This payment method has successfully been verified and can now be used to create payments.

… 2 more
api_version
string
object

Raw credit card information.

object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

object

Raw bank account information.

400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "type": "payment_bank_us",
  • "payment_bank_us": null,
  • "custom_data": null
}
Response samples
application/json
{
  • "create_time": 1512429148,
  • "credit_card": {
    • "auto_update": false,
    • "backing_display_name": null,
    • "bin": "549619",
    • "card_brand": "mastercard",
    • "card_entry_type": "card_keyed",
    • "card_holder": {
      • "address": {
        • "city": "",
        • "country": "US",
        • "line1": "",
        • "line2": "",
        • "postal_code": "94025",
        • "region": ""
        },
      • "email": "example@wepay.com",
      • "holder_name": "John Snow",
      • "phone": {
        • "country_code": null,
        • "phone_number": null,
        • "type": null
        }
      },
    • "display_name": "MasterCard xxxxxx4769",
    • "expiration_month": 4,
    • "expiration_year": 2020,
    • "last_four": "4769",
    • "virtual_terminal_mode": null,
    • "card_on_file": false,
    • "recurring": false,
    • "cvv_provided": true
    },
  • "custom_data": {
    • "order_number": 696868
    },
  • "id": "00000000-6363-0000-0000-0000cd225fe1",
  • "owner": {
    • "id": "171845",
    • "path": null,
    • "resource": "applications"
    },
  • "path": "/payment_methods/00000000-6363-0000-0000-0000cd225fe1",
  • "resource": "payment_methods",
  • "status": "verified",
  • "type": "credit_card",
  • "api_version": "3.0"
}