---
agentTools:
  projectIndex: https://developer.flutterwave.com/llms.txt
---

# Standard API

Generate Flutterwave checkout to receive payments from customers. Learn more about our [checkout](/v3.0.0/docs/flutterwave-standard-1)

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Flutterwave v3",
    "version": "3.0.0"
  },
  "servers": [
    {
      "url": "https://api.flutterwave.com/v3"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/payments": {
      "post": {
        "summary": "Standard API",
        "description": "Generate Flutterwave checkout to receive payments from customers. Learn more about our [checkout](/v3.0.0/docs/flutterwave-standard-1)",
        "operationId": "checkout",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Pass your secret key as a bearer token in the request header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "amount",
                  "tx_ref",
                  "customer"
                ],
                "properties": {
                  "amount": {
                    "type": "integer",
                    "description": "The amount to be charged for the transaction",
                    "default": 1000,
                    "format": "int32"
                  },
                  "tx_ref": {
                    "type": "string",
                    "description": "Unique reference for the transaction",
                    "default": "YOUR_PAYMENT_REFERENCE"
                  },
                  "currency": {
                    "type": "string",
                    "description": "The currency to charge in. Defaults to \"NGN\" if not specified",
                    "default": "NGN"
                  },
                  "redirect_url": {
                    "type": "string",
                    "description": "URL to redirect the customer to after payment is completed",
                    "default": "https://www.flutterwave.com/ng"
                  },
                  "customer": {
                    "type": "object",
                    "description": "An object containing the customer’s details",
                    "required": [
                      "email"
                    ],
                    "properties": {
                      "email": {
                        "type": "string",
                        "description": "Customer's email address",
                        "default": "user@example.com"
                      },
                      "phone_number": {
                        "type": "string",
                        "description": "The customer’s mobile number",
                        "default": "08012345612"
                      },
                      "name": {
                        "type": "string",
                        "description": "Customer’s name",
                        "default": "Mike John"
                      }
                    }
                  },
                  "customizations": {
                    "type": "object",
                    "description": "An object containing options to customize the look of the payment modal",
                    "properties": {
                      "title": {
                        "type": "string",
                        "description": "Name/title to display on the checkout page",
                        "default": "Web Demo Payment"
                      },
                      "logo": {
                        "type": "string",
                        "description": "Merchant's logo URL",
                        "default": "http://www.piedpiper.com/app/themes/joystick-v27/images/logo.png"
                      }
                    }
                  },
                  "configuration": {
                    "type": "object",
                    "description": "The checkout configurations",
                    "properties": {
                      "session_duration": {
                        "type": "integer",
                        "description": "Duration (in minutes) the session should remain valid (max: 1440)",
                        "default": 30,
                        "format": "int32"
                      },
                      "max_retry_attempt": {
                        "type": "integer",
                        "description": "Max number of retry attempts for failed transactions",
                        "default": 5,
                        "format": "int32"
                      }
                    }
                  },
                  "payment_plan": {
                    "type": "integer",
                    "description": "ID of the payment plan (used for recurring payments)",
                    "default": 3807,
                    "format": "int32"
                  },
                  "payment_options": {
                    "type": "string",
                    "description": "Comma-separated list of payment methods to display",
                    "default": "card, ussd, mobilemoneyghana"
                  },
                  "link_expiration": {
                    "type": "string",
                    "description": "Sets how long the hosted payment link remains valid",
                    "default": "2024-02-14T12:20:00",
                    "format": "date"
                  },
                  "subaccounts": {
                    "type": "array",
                    "description": "Array of objects specifying subaccount IDs for split payments",
                    "items": {
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "This is the unique Id returned in the call to create a subaccount as `data.subaccount_id`",
                          "default": "RS_D87A9EE339AE28BFA2AE86041C6DE70E"
                        }
                      },
                      "type": "object"
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Extra metadata you’d like to store with the transaction",
                    "properties": {
                      "meta_1": {
                        "type": "string",
                        "default": "meta_value"
                      },
                      "meta_2": {
                        "type": "string",
                        "default": "meta_value"
                      }
                    }
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "tx_ref": "YOUR_TRANSACTION_REFERENCE",
                    "amount": "200",
                    "currency": "NGN",
                    "redirect_url": "https://flutterwave.com/ng",
                    "customer": {
                      "email": "user@example.com",
                      "phone_number": "08101112121",
                      "name": "Example User"
                    },
                    "customizations": {
                      "title": "Pied Piper Payments",
                      "logo": "http://www.piedpiper.com/app/themes/joystick-v27/images/logo.png"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"message\": \"Hosted Link\",\n    \"data\": {\n        \"link\": \"https://checkout.flutterwave.com/v3/hosted/pay/flwlnk-01j4dc4maegqf82pfqg4chw46b\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": "Hosted Link"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "link": {
                          "type": "string",
                          "example": "https://checkout.flutterwave.com/v3/hosted/pay/flwlnk-01j4dc4maegqf82pfqg4chw46b"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "5e36e596fe0cf5005142f849:67ff7113e0e1b600688416b4"
}
```