Create a payment method

Create a payment method

POST /payment-methods

Create a payment method

cURL

curl --request POST \
  --url https://developersandbox-api.flutterwave.com/payment-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "card",
  "card": {
    "nonce": "<string>",
    "encrypted_expiry_month": "sQpvQEb7GrUCjPuEN/NmHiPl",
    "encrypted_expiry_year": "sgHNEDkJ/RmwuWWq/RymToU5",
    "encrypted_card_number": "sAE3hEDaDQ+yLzo4Py+Lx15OZjBGduHu/DcdILh3En0=",
    "encrypted_cvv": "tAUzH7Qjma7diGdi7938F/ESNA==",
    "card_holder_name": "Alex James"
  },
  "customer_id": "cus_3XarBILKQS",
  "meta": {}
}
'

import requests

url = "https://developersandbox-api.flutterwave.com/payment-methods"

payload = {
    "type": "card",
    "card": {
        "nonce": "<string>",
        "encrypted_expiry_month": "sQpvQEb7GrUCjPuEN/NmHiPl",
        "encrypted_expiry_year": "sgHNEDkJ/RmwuWWq/RymToU5",
        "encrypted_card_number": "sAE3hEDaDQ+yLzo4Py+Lx15OZjBGduHu/DcdILh3En0=",
        "encrypted_cvv": "tAUzH7Qjma7diGdi7938F/ESNA==",
        "card_holder_name": "Alex James"
    },
    "customer_id": "cus_3XarBILKQS",
    "meta": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'card',
    card: {
      nonce: '<string>',
      encrypted_expiry_month: 'sQpvQEb7GrUCjPuEN/NmHiPl',
      encrypted_expiry_year: 'sgHNEDkJ/RmwuWWq/RymToU5',
      encrypted_card_number: 'sAE3hEDaDQ+yLzo4Py+Lx15OZjBGduHu/DcdILh3En0=',
      encrypted_cvv: 'tAUzH7Qjma7diGdi7938F/ESNA==',
      card_holder_name: 'Alex James'
    },
    customer_id: 'cus_3XarBILKQS',
    meta: {}
  })
};

fetch('https://developersandbox-api.flutterwave.com/payment-methods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developersandbox-api.flutterwave.com/payment-methods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'card',
    'card' => [
        'nonce' => '<string>',
        'encrypted_expiry_month' => 'sQpvQEb7GrUCjPuEN/NmHiPl',
        'encrypted_expiry_year' => 'sgHNEDkJ/RmwuWWq/RymToU5',
        'encrypted_card_number' => 'sAE3hEDaDQ+yLzo4Py+Lx15OZjBGduHu/DcdILh3En0=',
        'encrypted_cvv' => 'tAUzH7Qjma7diGdi7938F/ESNA==',
        'card_holder_name' => 'Alex James'
    ],
    'customer_id' => 'cus_3XarBILKQS',
    'meta' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developersandbox-api.flutterwave.com/payment-methods"

	payload := strings.NewReader("{\n  \"type\": \"card\",\n  \"card\": {\n    \"nonce\": \"<string>\",\n    \"encrypted_expiry_month\": \"sQpvQEb7GrUCjPuEN/NmHiPl\",\n    \"encrypted_expiry_year\": \"sgHNEDkJ/RmwuWWq/RymToU5\",\n    \"encrypted_card_number\": \"sAE3hEDaDQ+yLzo4Py+Lx15OZjBGduHu/DcdILh3En0=\",\n    \"encrypted_cvv\": \"tAUzH7Qjma7diGdi7938F/ESNA==\",\n    \"card_holder_name\": \"Alex James\"\n  },\n  \"customer_id\": \"cus_3XarBILKQS\",\n  \"meta\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://developersandbox-api.flutterwave.com/payment-methods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"card\",\n  \"card\": {\n    \"nonce\": \"<string>\",\n    \"encrypted_expiry_month\": \"sQpvQEb7GrUCjPuEN/NmHiPl\",\n    \"encrypted_expiry_year\": \"sgHNEDkJ/RmwuWWq/RymToU5\",\n    \"encrypted_card_number\": \"sAE3hEDaDQ+yLzo4Py+Lx15OZjBGduHu/DcdILh3En0=\",\n    \"encrypted_cvv\": \"tAUzH7Qjma7diGdi7938F/ESNA==\",\n    \"card_holder_name\": \"Alex James\"\n  },\n  \"customer_id\": \"cus_3XarBILKQS\",\n  \"meta\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developersandbox-api.flutterwave.com/payment-methods")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"card\",\n  \"card\": {\n    \"nonce\": \"<string>\",\n    \"encrypted_expiry_month\": \"sQpvQEb7GrUCjPuEN/NmHiPl\",\n    \"encrypted_expiry_year\": \"sgHNEDkJ/RmwuWWq/RymToU5\",\n    \"encrypted_card_number\": \"sAE3hEDaDQ+yLzo4Py+Lx15OZjBGduHu/DcdILh3En0=\",\n    \"encrypted_cvv\": \"tAUzH7Qjma7diGdi7938F/ESNA==\",\n    \"card_holder_name\": \"Alex James\"\n  },\n  \"customer_id\": \"cus_3XarBILKQS\",\n  \"meta\": {}\n}"

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

201

{
  "message": "<string>",
  "data": {
    "id": "pmd_WRq7L4TM8p",
    "type": "card",
    "card": {
      "expiry_month": "09",
      "expiry_year": "32",
      "first6": "123412",
      "last4": "1234",
      "network": "MASTERCARD",
      "billing_address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main Street",
        "postal_code": "10001",
        "state": "New York",
        "line2": "Apt 4B"
      },
      "cof": {
        "enabled": true,
        "agreement_id": "Agreement00w02W1",
        "recurring_amount_variability": "VARIABLE",
        "agreement_type": "UNSCHEDULED",
        "trace_id": "123456789"
      },
      "card_holder_name": "Alex James"
    },
    "customer_id": "cus_3XarBILKQS",
    "meta": {},
    "device_fingerprint": "62wd23423rq324323qew1",
    "client_ip": "154.123.220.1",
    "created_datetime": "2024-12-03T13:54:21.546559974Z"
  }
}

{
  "status": "failed",
  "error": {
    "type": "REQUEST_NOT_VALID",
    "code": "10400",
    "message": "Request is not valid",
    "validation_errors": [
      {
        "field_name": "amount",
        "message": "must not be null"
      }
    ]
  }
}

{
  "status": "failed",
  "message": "UNAUTHORIZED",
  "error": {
    "type": "UNAUTHORIZED",
    "code": "10401",
    "message": "unauthorized"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "FORBIDDEN",
    "code": "10403",
    "message": "Forbidden"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "RESOURCE_CONFLICT",
    "code": "10409",
    "message": "Resource conflict"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Trace-Id · string

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Required string length: 12 - 255

X-Idempotency-Key · string

A unique identifier to prevent duplicate requests. It must be between 12 and 255 characters in length.

Required string length: 12 - 255

Body

application/json

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

type · string · required

The type of the payment method.

Example:

"card"

card · object · required

Show child attributes

customer_id · string

ID of the customer.

Example:

"cus_3XarBILKQS"

meta · object

Show child attributes

Response

201

application/json

OK

status · enum<string>

Available options: success, failed

message · string

data · object

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes