Provider guide

Stripe

Integration notes, required parameters, test details and example requests for integrating Stripe with the Revo PCI platform.

Test integrationProvider support
At a glance
3
Supported transaction types
Supported modes
SALE, TOKEN, TOKENSALE
Key setup requirement
RAW API access and MOTO enabled
!
Important
Stripe have very small requirements for taking a payment, however it is best to provide as much information as possible so that the payment goes through successfully.
!
Important
Your Stripe account needs to have RAW API access enabled and MOTO payments which are gated features. For more information, see here.
Testing

Test card details

Card Number:
4242424242424242
Expiry Date:
0531
CVV:
123

Stripe have more test cards which can be found here.

Overview

Integration requirements

Required parameters

transactionType

'SALE' is supported which will take a payment from the requested card.

'TOKEN' is supported which is for tokenising the card details for use later.

'TOKENSALE' is supported for taking a payment with an existing token.

apiKey
This is provided by Stripe.
Transactions

Supported transaction types

Required parameters

amount
Always has to be a whole number, for example £2 is 200. This is true if your exponent is set to '2' for GBP
currency
Must be provided as 3 letters for example: 'GBP'.

Optional parameters

shippingName
Full name of the receiver.
shippingLine1
First line of address for the receiver.
shippingLine2
Second line of address for the receiver.
shippingCity
City for the receiver.
shippingState
State for the receiver.
shippingPostalCode
Postcode for the receiver.
shippingCountry
Country for the receiver.
description
Description for this payment.
statementDescriptorSuffix
How will it appear on the card holders bank statement.

Stripe may support other parameters not currently integrated into the PCI platform, more information can be found here, if you would like any integrated please contact us.

Required parameters

No extra parameters are required by the TOKEN transactionType.

Required parameters

paymentMethod
Id of the payment method to use.
amount
Always has to be a whole number, for example £2 is 200. This is true if your exponent is set to '2' for GBP
currency
Must be provided as 3 letters for example: 'GBP'.
Reference

Example request

cURL exampleAPI request
curl --location 'https://api.revopci.co.uk/' \
            --header 'X-Session;' \
            --header 'X-Auth;' \
            --header 'Content-Type: application/json' \
            --data '{
            "provider": "stripe",
            "mode": "test",
            "payment": "payment",
            "parameters":
            {
            "transactionType": "SALE" or "TOKEN" or "TOKENSALE",
            "apiKey": "00000000-0000-0000-0000-000000000000"

            //SALE
            "amount": "200",
            "currency": "GBP",
            "shippingName": "Test Test",
            "shippingLine1": "123 Test Street",
            "shippingLine2": "",
            "shippingCity": "Test",
            "shippingState": "Test",
            "shippingPostalCode": "SANTA1",
            "shippingCountry": "Test",
            "description": "This is a test payment",
            "statementDescriptorSuffix": "TEST002"

            //TOKEN
            "billingName": "Test Test",
            "billingLine1": "123 Test Street",
            "billingLine2": "",
            "billingCity": "Test",
            "billingState": "Test",
            "billingPostalCode": "SANTA1",
            "billingCountry": "Test",

            //TOKENSALE
            "paymentMethod": "00000000-0000-0000-0000-000000000000",
            "amount": "200",
            "currency": "GBP",
            "billingName": "Test Test",
            "billingLine1": "123 Test Street",
            "billingLine2": "",
            "billingCity": "Test",
            "billingState": "Test",
            "billingPostalCode": "SANTA1",
            "billingCountry": "Test",
            }
            }'