---
updatedAt: 2026-04-28T11:47:33.000Z
agentTools:
  projectIndex: https://docs.interswitchgroup.com/llms.txt
---

# Card Payment API

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "accept-payment",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://sandbox.interswitchng.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v3/purchases": {
      "post": {
        "summary": "Card Payment API",
        "description": "",
        "operationId": "card-payment-api",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Set value to \"Bearer ACCESS_TOKEN\"",
            "schema": {
              "type": "string",
              "default": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOlsiaXN3LWNvbGxlY3Rpb25zIiwiaXN3LXBheW1lbnRnYXRld2F5IiwicGFzc3BvcnQiLCJwcm9qZWN0LXgtbWVyY2hhbnQiLCJ2YXVsdCJdLCJtZXJjaGFudF9jb2RlIjoiTVg2MDcyIiwicmVxdWVzdG9yX2lkIjoiMTIzODA4NTk1MDMiLCJzY29wZSI6WyJwcm9maWxlIl0sImp0aSI6IjVkOTczM2Y5LWMzNDEtNGFjZC04ZjE3LWViYzUyYWE0NjM2MiIsInBheWFibGVfaWQiOiIzMzU5NyIsImNsaWVudF9pZCI6IklLSUFCMjNBNEUyNzU2NjA1QzFBQkMzM0NFM0MyODdFMjcyNjdGNjYwRDYxIn0.ElgBX2KoF9LuUUpeBGzzp8CDAllTHWfgM6pJRgTtPYGJpoZufKlJrmE4QTvZV6MIVaNtK21majTgR4qXJr7CEkPK_4zCIHyN2b8a445vqhLYcbffQvK4EeUn_RzsWTmub2bruG5s4bRS1il5itPR0QQ-trEsbELU7TAHvC4p786RiAQd-K_I0bwtLzIXQN65jlw3eJxxK-BGfca-OMTUo9HGvraebfLB-7h4-vNbPred58gfLBSwK31jaLP19cMRc5Jea28jrlmGNUhHGzjnP7ZanqgC9uuvoepQsa39_DNBonR6xirxKw4aNlNLcKOTn026wyOTHIHUGlDQ3s3AOQ"
            }
          },
          {
            "name": "Content-Type",
            "in": "header",
            "description": "Set value to \"application/json\"",
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "customerId",
                  "amount",
                  "transactionRef",
                  "currency",
                  "authData"
                ],
                "properties": {
                  "customerId": {
                    "type": "string",
                    "description": "Unique identifier for the customer",
                    "default": "customer@test.com"
                  },
                  "amount": {
                    "type": "string",
                    "description": "The amount being paid. This is usually in the smallest currency unit (e.g Naira)",
                    "default": "10000"
                  },
                  "transactionRef": {
                    "type": "string",
                    "description": "Unique transaction reference per transaction."
                  },
                  "currency": {
                    "type": "string",
                    "description": "Currency being used.",
                    "default": "NGN"
                  },
                  "authData": {
                    "type": "string",
                    "description": "Combination of the sensitive data of the payment (PAN, PIN, Expiry Date, and CVV2)",
                    "default": "G3cf/VTtAHCdHZNxc5GXWRI8z5P0goL2amXWDVFgb6D3XK/QMtZW90TYdl5zffDCNpiZThJzk0+eEU/Y/aYS6fyIOpQZGFrOr8hmvx5869sl2kr5u8qjnM7q5b4ZnTqdKDLtNxr3Qr7anj6YLpox1FOsiyT26mktXL+7SFOaZ15NMtne1z4xrj4R2SndowI/Znsapo7Gfzvp+L7XJyQ8kLYYRk3INjvmRPPQoJg1R0Nnh6EQE3ldIdwylB7GKtr6a71N/yCd4ZtyIcqq1ZNzdWcZyy5eEBAlDIxuECdBqH6hRq2/RbkfARqidNN4Kq0WviSRaRYGbiNjl2W9pNcM8g=="
                  },
                  "deviceInformation": {
                    "type": "string",
                    "description": "It is compulsory to collect device information from the user's browser and include it in the payment request.",
                    "default": "{         \"httpBrowserLanguage\": \"en-US\",         \"httpBrowserJavaEnabled\": false,         \"httpBrowserJavaScriptEnabled\": true,         \"httpBrowserColorDepth\": \"24\",         \"httpBrowserScreenHeight\": \"820\",         \"httpBrowserScreenWidth\": \"360\",         \"httpBrowserTimeDifference\": \"\",         \"userAgentBrowserValue\": \"Mozilla/5.0 (Linux; Android 12; Infinix X6819) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Mobile Safari/537.36\",         \"deviceChannel\": \"Browser\"     }",
                    "format": "json"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"transactionRef\": \"12n345mmm0km655\",\n    \"paymentId\": \"3530471\",\n    \"message\": \"Kindly enter the OTP sent to 234805***1111\",\n    \"amount\": \"20000.00\",\n    \"responseCode\": \"T0\",\n    \"plainTextSupportMessage\": \"Didn't get the OTP? Dial *723*0# on your phone (MTN,Etisalat,Airtel) Glo,use *805*0#.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "transactionRef": {
                      "type": "string",
                      "example": "12n345mmm0km655"
                    },
                    "paymentId": {
                      "type": "string",
                      "example": "3530471"
                    },
                    "message": {
                      "type": "string",
                      "example": "Kindly enter the OTP sent to 234805***1111"
                    },
                    "amount": {
                      "type": "string",
                      "example": "20000.00"
                    },
                    "responseCode": {
                      "type": "string",
                      "example": "T0"
                    },
                    "plainTextSupportMessage": {
                      "type": "string",
                      "example": "Didn't get the OTP? Dial *723*0# on your phone (MTN,Etisalat,Airtel) Glo,use *805*0#."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```