Payment Method Update

1 min

POST

https://api.butterpayments.com/recover/payment_method_updates

This endpoint is used by the merchant to notify Recover of an update to a payment method for a customer. Whenever a payment method has been updated, added, or removed for any reason, that event should be forwarded to this endpoint so that it can be used as a signal to increase Recover's performance.

Add field values in the boxes below to create an example payload on the right side of the screen.

Body Parameters

bodypayment_method_updaterequired
- customer_idstringrequired
  Example
  11223344
  Description
  The internal identifier from your subscription management platform used to designate the customer. Either customer_id or psp_customer_id must be populated.
- psp_customer_idstring
  Example
  cus_12345
  Description
  The identifier used by the Payment Processor to designate the customer. Either customer_id or psp_customer_id must be populated.
- payment_method_idstringrequired
  Example
  pm_12345
  Description
  The id from the PSP representing the payment method.
- reasonstring<user_added | user_removed | user_updated | network_updated>
  Example
  user_updated
  Description
  What action lead to this event?

Responses

200Request Successful

inline_response_200
- messagestring
  Example
  Request submitted for processing
  Default
  Request submitted for processing
- request_idstring
  Example
  2c941653-b229-4528-b576-70fcfd388543:49645839701979566120793328447151049151317978254208401410:000000000000
  Default
  2c941653-b229-4528-b576-70fcfd388543:49645839701979566120793328447151049151317978254208401410:000000000000

400Request Failed Validation

inline_response_400
- messagestring
  Example
  Invalid request body
  Default
  Invalid request body
- errorsobject[]
  Example
```
[
  {
    "('subscription', 'start_date')": "Field required"
  }
]
```
  Default
  {"('subscription', 'start_date')":"Field required"}

403Invalid API Key

inline_response_403
- messagestring
  Example
  Forbidden
  Default
  Forbidden
- errorsstring
  Example
  Invalid API Key
  Default
  Invalid API Key

404Method/Path Not Found

inline_response_404
- messagestring
  Example
  Method/Path combination not found.
  Default
  Method/Path combination not found.

415Unsupported Media Type

inline_response_415
- messagestring
  Example
  Unsupported Media Type
  Default
  Unsupported Media Type
- errorsstring
  Example
  Content-Type must be application/json
  Default
  Content-Type must be application/json

500Server Error

curl

curl --request POST \
     --url https://api.butterpayments.com/recover/payment_method_updates \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customer_id": "11223344",
     "payment_method_id": "pm_12345"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "customer_id": "11223344",
   "payment_method_id": "pm_12345"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.butterpayments.com/recover/payment_method_updates", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.butterpayments.com/recover/payment_method_updates")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "customer_id": "11223344",
   "payment_method_id": "pm_12345"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.butterpayments.com/recover/payment_method_updates"

payload = json.dumps({
   "customer_id": "11223344",
   "payment_method_id": "pm_12345"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Request Successful
{
  "message": "Request submitted for processing",
  "request_id": "2c941653-b229-4528-b576-70fcfd388543:49645839701979566120793328447151049151317978254208401410:000000000000"
}

400

// Request Failed Validation
{
  "message": "Invalid request body",
  "errors": [
    {}
  ]
}

403

// Invalid API Key
{
  "message": "Forbidden",
  "errors": "Invalid API Key"
}

404

// Method/Path Not Found
{
  "message": "Method/Path combination not found."
}

415

// Unsupported Media Type
{
  "message": "Unsupported Media Type",
  "errors": "Content-Type must be application/json"
}

500

// Server Error

Add field values in the boxes below to create an example payload on the right side of the screen.