Card

post https://api.flutterwave.com/v3/charges?type=card

Collect card payments with Flutterwave. We recommend you read the method overview before you proceed.

Body Params

amount

int32

required

Defaults to 100

This is the amount to be charged.

currency

string

required

Defaults to NGN

This is the specified currency to charge in.

card_number

string

required

Defaults to 5399670123490229

This is the number on the cardholders card. E.g. 5399 6701 2349 0229.

cvv

string

required

Defaults to 123

Card security code. This is 3/4 digit code at the back of the customers card, used for web payments.

expiry_month

int32

required

Defaults to 1

Two-digit number representing the card's expiration month.

expiry_year

int32

required

Defaults to 21

Two digit number representing the card's expiration year

string

required

Defaults to user@flw.com

This is the email address of the customer

tx_ref

string

required

Defaults to MC-3243e

This is a unique reference peculiar to the transaction being carried out.

authorization

object

This is an object that contains the authorization details of the card you want to charge. The authorization instructions for card charges are returned in the initiate charge call as meta.authorization

preauthorize

boolean

Defaults to false

This should be set to true for preauthoize card transactions

fullname

string

Defaults to Yemi Desola

This is the name of the customer.

card_holder_name

string

The full name of the cardholder. This is only required for charges on AMEX cards.

phone_number

string

Defaults to 07033002245

The phone number linked to the customer's bank account. This is required for AMEX card charge.

payment_plan

string

Defaults to 12345

This is the id of a previously created payment plan needed to add a card user to the payment plan.

redirect_url

string

Defaults to https://webhook.site/3ed41e38-2c79-4c79-b455-97398730866c

This is a url you provide, we redirect to it after the customer completes payment and append the response to it as query parameters. (3DSecure only)

meta

object

This is used to include additional payment information

device_fingerprint

string

Defaults to 62wd23423rq324323qew1

This is the fingerprint for the device being used. It can be generated using a library on whatever platform is being used

client_ip

string

Defaults to 154.123.220.1

IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction

eci

string

Defaults to 03

This is the Electronic Commerce Indicator (ECI) value provided by the issuer's Access Control Server (ACS) to indicate the results of the attempt to authenticate the payer. This is required for external 3DS transactions.

a_authenticationtoken

string

required

Defaults to zPkn+YYYYYY53434HFHDss=

This represents the base64 encoded value generated by the card issuer that is returned in the authentication response message and its a required fields from the card schemes documentation.

a_amount

string

Defaults to 100

The amount for which the payer authentication has been performed. This is required for external 3DS transactions.

a_version

string

Defaults to 2.1.0

EMV 3-D Secure protocol e.g. 2.1.0. This is required for external 3DS transactions.

a_transactionid

string

Defaults to 1F3Uciah9cnh4mrnPPtyT_RA_test

A unique transaction identifier assigned by the Access Control Server to identify the 3DS transaction. This is required for external 3DS transactions.

a_transactionstatus

string

Defaults to Y

ou are expected to pass Y to indicate that the authorization was successful. Other options include N, U, A, R. It is recommended that you only attempt to charge for successful authorization. This is required for external 3DS transactions.

a_statusreasoncode

string

required

Defaults to 33

If a_transactionstatus Y then this becomes optional. This is required for external 3DS transactions.

is_custom_3ds_enabled

boolean

required

Defaults to true

This indicates the use of a custom 3DS provider and as a result the eci, a_authentication, a_version, a_transactionid, a_transactionstatus, a_amount, a_time and a_statusreasoncode are taken into consideration. This is required for external 3DS transactions.

a_time

date

Defaults to 2024-04-11T08:08:43.974Z

It indicates the date and time of the payer's authentication and the card scheme makes use of UTC format. This is required for external 3DS transactions.

Headers

Authorization

string

required

Defaults to Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X

Pass your secret key as a bearer token in the request header to authorize this call

Responses

Language


xxxxxxxxxx
46
  "redirect_url": "https://webhook.site/3ed41e38-2c79-4c79-b455-97398730866c",
1
curl --request POST \
2
     --url 'https://api.flutterwave.com/v3/charges?type=card' \
3
     --header 'Authorization: Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X' \
4
     --header 'Content-Type: application/json' \
5
     --header 'accept: application/json' \
6
     --data '
7
{
8
  "amount": 100,
9
  "currency": "NGN",
10
  "card_number": "5399670123490229",
11
  "cvv": "123",
12
  "expiry_month": 1,
13
  "expiry_year": 21,
14
  "email": "user@flw.com",
15
  "tx_ref": "MC-3243e",
16
  "authorization": {
17
    "mode": "pin",
18
    "pin": 2245,
19
    "city": "San Francisco",
20
    "address": "333 Fremont Street, San Francisco, CA",
21
    "state": "California",
22
    "country": "US",
23
    "zipcode": 94105


xxxxxxxxxx
47
}
1
{
2
  "status": "success",
3
  "message": "Charge initiated",
4
  "data": {
5
    "id": 288192886,
6
    "tx_ref": "LiveCardTest",
7
    "flw_ref": "YemiDesola/FLW275389391",
8
    "device_fingerprint": "N/A",
9
    "amount": 100,
10
    "charged_amount": 100,
11
    "app_fee": 1.4,
12
    "merchant_fee": 0,
13
    "processor_response": "Kindly enter the OTP sent to *******0328",
14
    "auth_model": "PIN",
15
    "currency": "NGN",
16
    "ip": "::ffff:10.7.214.204",
17
    "narration": "CARD Transaction ",
18
    "status": "pending",
19
    "auth_url": "N/A",
20
    "payment_type": "card",
21
    "fraud_status": "ok",
22
    "charge_type": "normal",

200200

400400