Manage a business's payment methods.
Show all of a business's payment methods.
| Method | URI | Authentication |
|---|---|---|
GET |
/business/{unique_id}/payment-methods |
true |
{success} Example Success Response Code
200
Content
{
"success": true,
"message": "Show payment methods",
"data": [
{
"id": "pm_1HUBTHD2YnIDoaEIlLFGrCE8",
"object": "payment_method",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": null,
"phone": null
},
"card": {
"brand": "mastercard",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 3,
"exp_year": 2022,
"fingerprint": "h18IlRcbcU3djRqA",
"funding": "debit",
"generated_from": null,
"last4": "8210",
"networks": {
"available": [
"mastercard"
],
"preferred": null
},
"three_d_secure_usage": {
"supported": true
},
"wallet": null
},
"created": 1600781031,
"customer": "cus_I4K7grXAClDEcl",
"livemode": false,
"metadata": [],
"type": "card",
"default": false
},
{
"id": "pm_1HUBTFD2YnIDoaEITKKoima0",
"object": "payment_method",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": null,
"phone": null
},
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 6,
"exp_year": 2021,
"fingerprint": "79RdvAqUWe4Fl0xo",
"funding": "credit",
"generated_from": null,
"last4": "4242",
"networks": {
"available": [
"visa"
],
"preferred": null
},
"three_d_secure_usage": {
"supported": true
},
"wallet": null
},
"created": 1600781029,
"customer": "cus_I4K7grXAClDEcl",
"livemode": false,
"metadata": [],
"type": "card",
"default": false
},
{
"id": "pm_1HUBTFD2YnIDoaEITKKoima0",
"object": "payment_method",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": null,
"phone": null
},
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 6,
"exp_year": 2021,
"fingerprint": "79RdvAqUWe4Fl0xo",
"funding": "credit",
"generated_from": null,
"last4": "4242",
"networks": {
"available": [
"visa"
],
"preferred": null
},
"three_d_secure_usage": {
"supported": true
},
"wallet": null
},
"created": 1600781029,
"customer": "cus_I4K7grXAClDEcl",
"livemode": false,
"metadata": [],
"type": "card",
"default": true
}
]
}
Save a payment method for a business.
| Method | URI | Authentication |
|---|---|---|
POST |
/business/{unique_id}/payment-methods |
true |
| Name | Type | Status | Description |
|---|---|---|---|
payment_method_id |
string |
required |
The id of the payment method object created by Stripe. |
{success} Example Success Response Code
200
Content
{
"success": true,
"message": "Payment method has been saved.",
"data": {
"id": "pm_1HUBZYD2YnIDoaEIs8vrcDv7",
"object": "payment_method",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": null,
"phone": null
},
"card": {
"brand": "discover",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 6,
"exp_year": 2022,
"fingerprint": "Rqby8zuDfpkHD2Yc",
"funding": "credit",
"generated_from": null,
"last4": "1117",
"networks": {
"available": [
"discover"
],
"preferred": null
},
"three_d_secure_usage": {
"supported": false
},
"wallet": null
},
"created": 1600781420,
"customer": "cus_I4K7grXAClDEcl",
"livemode": false,
"metadata": [],
"type": "card"
}
}
Update a business's default payment method.
| Method | URI | Authentication |
|---|---|---|
PATCH |
/business/{unique_id}/payment-method/{payment_method_id} |
true |
{success} Example Success Response Code
200
Content
{
"success": true,
"message": "Your default payment method has been updated.",
"data": null
}
Remove a business's payment method.
| Method | URI | Authentication |
|---|---|---|
DELETE |
/business/{unique_id}/payment-method/{payment_method_id} |
true |
{success} Example Success Response Code
200
Content
{
"success": true,
"message": "This payment method has been removed.",
"data": null
}