{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml","oas-apis/openapi.yaml":"oas-apis/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["replay-openapi"]},"type":"markdown"},"seo":{"title":"Reefpay Docs","description":"Reefpay is the groundbreaking payment gateway that lets you integrate with the future of payments.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"quickstart","__idx":0},"children":["Quickstart"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This quickstart walks you through authenticating with the ","Reefpay"," API and processing your first test transaction. It is intended for developers who are ready to start integrating."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"prerequisites","__idx":2},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin, make sure you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ","Reefpay"," account with sandbox access"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your API key"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A tool for making HTTP requests (curl, Postman, or equivalent)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-you-will-accomplish","__idx":3},"children":["What you will accomplish"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By the end of this quickstart you will have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Processed a test credit card sale"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Understood the structure of a transaction response"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"process-a-test-sale","__idx":4},"children":["Process a test sale"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With your API key, send a credit card sale to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/transactions"]},". The example below charges 19.99 US dollars (USD) to a test Visa card."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUR-API-KEY"]}," with the value for your API key."," ","Amounts are in the smallest currency unit (cents for USD), so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["20000"]}," equals 200.00 US dollars (USD)."]},{"$$mdtype":"Tag","name":"ReplayOpenApi","attributes":{"descriptionFile":"oas-apis/openapi.yaml","operationId":"createTransaction","parameters":{},"requestBody":{"type":"SALE","amount":20000,"currency":"USD","payment_method":{"type":"CARD","pan":"4263970000005262","expiry":{"month":"12","year":"2028"},"cvv":"999"},"recurring":false},"options":{},"environments":{"https://api.dev.paradisegateway.net":{"ApiKeyAuth":"a4cacf98-7855-4c84-aca0-432f10077e80"}}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"understanding-the-response-example","__idx":5},"children":["Understanding the response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful sale returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," with the transaction details."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," confirms the payment was approved."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction_id"]},": The unique identifier for the transaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response_code"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["00"]}," indicates success."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference_id"]},": The reference ID for the transaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_code"]},": The authorization code for the transaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response_description"]},": The description of the response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requested_amount"]},": The amount requested for the transaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card_holder_name"]},": The name of the card holder."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},": The type of transaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["batch_id"]},": The settlement batch this transaction belongs to."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":6},"children":["Next steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You used your API key to authenticate and processed your first test sale. Here are some next steps to continue your integration:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/transactions/transaction-lifecycle"},"children":["About the transaction lifecycle"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/process-payments/process-payment-with-token"},"children":["Processing a payment with a stored token"]}]}]}]},"headings":[{"value":"Quickstart","id":"quickstart","depth":1},{"value":"Introduction","id":"introduction","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":3},{"value":"What you will accomplish","id":"what-you-will-accomplish","depth":3},{"value":"Process a test sale","id":"process-a-test-sale","depth":2},{"value":"Understanding the response example","id":"understanding-the-response-example","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Quickstart","shortTitle":"Quickstart","intro":"Get up and running with the {% $env.PUBLIC_BRAND_NAME %} API in five minutes. Retrieve your API key and process a test sale.","type":"quick_start","seo":{"title":""}},"lastModified":"2026-06-05T02:46:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/get-started/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}