API docs by Redocly

RevoluPAY Merchant API (1.0.0)

Download OpenAPI specification:

License: Apache 2.0

Merchant TPV service for registered businesses.

login

Returns authentication object that contains valid token for the rest of the API calls.

Returns authentication object that contains valid token for the rest of the API calls.

Authorizations:
api_key
header Parameters
rv-authorization
required
string

Base64 encode de user:password para la aplicación

x-api-key
required
string

Api key

Responses

Response samples

Content type
application/json
{
  • "message": {
    }
}

create_client

Create a client to be able to tokenize their cards. Returns the client's token

To know the card tokenization process: https://paylands.docs.apiary.io/#introduction/sdk-javascript

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
customer_ext_id
required
string

Unique identifier of the client on the system consuming the API.

Responses

Request samples

Content type
{
  • "customer_ext_id": "CL1-000-CV-98"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

Create a client to be able to tokenize their cards. Returns the client's token

To know the card tokenization process: https://paylands.docs.apiary.io/#introduction/sdk-javascript

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Example: spanish

Language in which messages are received

header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
customer_ext_id
required
string

Unique identifier of the client on the system consuming the API.

Responses

Request samples

Content type
{
  • "customer_ext_id": "CL1-000-CV-98"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

create_order

It generates a payment order and returns the redirect url to the payment letter.

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
currency
required
string
Value: "EUR"

Currency in which the charge will be made

amount
required
number <integer>

Amount in cents in which the charge will be made

description
required
string

Concept for which the charge is made

order_ext_id
string

External identifier of the order, is usually the order identifier in the system of the user of this API.

customer_ext_id
string

Unique identifier of the client on the system consuming the API.

source_uuid
string

Tokenized card identifier.

url_post
string

Notification url where the API will send the result via POST once the sender makes the payment.

url_ok
string

url to which the sender will be redirected when the payment is successful

url_ko
string

url to which the sender will be redirected when the payment is not successful

clientFirstName
string

Cardholder name. Field required by VISA.

clientLastName
string

cardholder's last name. Field required by VISA.

clientEmail
string

cardholder's email. Field required by VISA.

clientPhonePrefix
number

Telephone prefix of the cardholder. Field required by VISA. It is recommended that at least an e-mail or telephone number be sent

clientPhoneNumber
number

Telephone number of the cardholder. Field required by VISA. It is recommended that at least an e-mail or telephone number be sent

clientAddressCity
string

Billing address city. Field required by VISA.

clientAddressCountryISO3
string

Country of billing address, ISO 3 format. Field required by VISA.

clientAddress
string

Billing address. Field required by VISA.

clientAddressZip
string

Billing address zip code. Field required by VISA.

clientAddressState
string

State/province of billing address. Field required by VISA.

Responses

Request samples

Content type
{
  • "currency": "EUR",
  • "amount": 1020,
  • "description": "Rocker T-shirt x 1",
  • "order_ext_id": "RTH-000001",
  • "customer_ext_id": "CL1-000-CV-98",
  • "source_uuid": "77777777-7777-4777-9777-777777777777",
  • "url_post": "https://midominio.com/guid/ghhghx0987ffe",
  • "url_ok": "https://midominio.com/guid/ghhghx0987ffe",
  • "url_ko": "https://midominio.com/guid/ghhghx0987ffe",
  • "clientFirstName": "Alan",
  • "clientLastName": "Brito Prieto",
  • "clientEmail": "alan.brito.prieto@example.com",
  • "clientPhonePrefix": 34,
  • "clientPhoneNumber": 938930586,
  • "clientAddressCity": "Sant Cugat del Vallés.",
  • "clientAddressCountryISO3": "ESP",
  • "clientAddress": "Vallespir, 19 1",
  • "clientAddressZip": "08173",
  • "clientAddressState": "Barcelona"
}

Response samples

Content type
application/json
{}

It generates a payment order and returns the redirect url to the payment letter.

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Example: spanish

Language in which messages are received

header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
currency
required
string
Value: "EUR"

Currency in which the charge will be made

amount
required
number <integer>

Amount in cents in which the charge will be made

description
required
string

Concept for which the charge is made

order_ext_id
string

External identifier of the order, is usually the order identifier in the system of the user of this API.

customer_ext_id
string

Unique identifier of the client on the system consuming the API.

source_uuid
string

Tokenized card identifier.

url_post
string

Notification url where the API will send the result via POST once the sender makes the payment.

url_ok
string

url to which the sender will be redirected when the payment is successful

url_ko
string

url to which the sender will be redirected when the payment is not successful

clientFirstName
string

Cardholder name. Field required by VISA.

clientLastName
string

cardholder's last name. Field required by VISA.

clientEmail
string

cardholder's email. Field required by VISA.

clientPhonePrefix
number

Telephone prefix of the cardholder. Field required by VISA. It is recommended that at least an e-mail or telephone number be sent

clientPhoneNumber
number

Telephone number of the cardholder. Field required by VISA. It is recommended that at least an e-mail or telephone number be sent

clientAddressCity
string

Billing address city. Field required by VISA.

clientAddressCountryISO3
string

Country of billing address, ISO 3 format. Field required by VISA.

clientAddress
string

Billing address. Field required by VISA.

clientAddressZip
string

Billing address zip code. Field required by VISA.

clientAddressState
string

State/province of billing address. Field required by VISA.

Responses

Request samples

Content type
{
  • "currency": "EUR",
  • "amount": 1020,
  • "description": "Rocker T-shirt x 1",
  • "order_ext_id": "RTH-000001",
  • "customer_ext_id": "CL1-000-CV-98",
  • "source_uuid": "77777777-7777-4777-9777-777777777777",
  • "url_post": "https://midominio.com/guid/ghhghx0987ffe",
  • "url_ok": "https://midominio.com/guid/ghhghx0987ffe",
  • "url_ko": "https://midominio.com/guid/ghhghx0987ffe",
  • "clientFirstName": "Alan",
  • "clientLastName": "Brito Prieto",
  • "clientEmail": "alan.brito.prieto@example.com",
  • "clientPhonePrefix": 34,
  • "clientPhoneNumber": 938930586,
  • "clientAddressCity": "Sant Cugat del Vallés.",
  • "clientAddressCountryISO3": "ESP",
  • "clientAddress": "Vallespir, 19 1",
  • "clientAddressZip": "08173",
  • "clientAddressState": "Barcelona"
}

Response samples

Content type
application/json
{}

attach_receipt

attachReceipt

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

receipt_file
required
string <base64encode>

Base64 encoded file. Document that justifies that the service / product was provided / delivered to the end customer. Allowed formats (gif,jpg,png,pdf)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288",
  • "receipt_file": "string"
}

Response samples

Content type
application/json
{}

attachReceiptLanguage

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Example: spanish

Language in which messages are received

header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

receipt_file
required
string <base64encode>

Base64 encoded file. Document that justifies that the service / product was provided / delivered to the end customer. Allowed formats (gif,jpg,png,pdf)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288",
  • "receipt_file": "string"
}

Response samples

Content type
application/json
{}

get_order

getOrder

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288"
}

Response samples

Content type
application/json
{}

getOrderLanguage

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Example: spanish

Language in which messages are received

header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288"
}

Response samples

Content type
application/json
{}

request_refun_order

requestRefunOrder

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

amount
required
number <integer>

amount in cents that is required to return

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288",
  • "amount": 1020
}

Response samples

Content type
application/json
{}

create_moto_order

Generates a payment order that is emailed to the customer

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
currency
required
string
Enum: "EUR" "USD"

Currency in which the charge will be made

amount
required
number <integer>

Amount in cents in which the charge will be made

email
required
string <email>

Customer email to send the payment order

subject
required
string

subject of the email that is sent to the client

details
string

Details of the concept for which the charge is made

description
required
string

Concept for which the charge is made

order_ext_id
string

External identifier of the order, is usually the order identifier in the system of the user of this API.

customer_ext_id
string

Unique identifier of the client on the system consuming the API.

url_post
string

Notification url where the API will send the result via POST once the sender makes the payment.

url_ok
string

url to which the sender will be redirected when the payment is successful

url_ko
string

url to which the sender will be redirected when the payment is not successful

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

Generates a payment order that is emailed to the customer

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Example: spanish

Language in which messages are received

header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
currency
required
string
Enum: "EUR" "USD"

Currency in which the charge will be made

amount
required
number <integer>

Amount in cents in which the charge will be made

email
required
string <email>

Customer email to send the payment order

subject
required
string

subject of the email that is sent to the client

details
string

Details of the concept for which the charge is made

description
required
string

Concept for which the charge is made

order_ext_id
string

External identifier of the order, is usually the order identifier in the system of the user of this API.

customer_ext_id
string

Unique identifier of the client on the system consuming the API.

url_post
string

Notification url where the API will send the result via POST once the sender makes the payment.

url_ok
string

url to which the sender will be redirected when the payment is successful

url_ko
string

url to which the sender will be redirected when the payment is not successful

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

attach_receipt_moto

attachReceiptMoto

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

receipt_file
required
string <base64encode>

Base64 encoded file. Document that justifies that the service / product was provided / delivered to the end customer. Allowed formats (gif,jpg,png,pdf)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288",
  • "receipt_file": "string"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

attachReceiptMotoLanguage

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Example: spanish

Language in which messages are received

header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

receipt_file
required
string <base64encode>

Base64 encoded file. Document that justifies that the service / product was provided / delivered to the end customer. Allowed formats (gif,jpg,png,pdf)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288",
  • "receipt_file": "string"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

get_moto_order

getOrderMoto

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderMotoResponse.Order.order.code)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

getOrderMotoLanguage

Authorizations:
api_key
path Parameters
language
required
string
Default: "english"
Example: spanish

Language in which messages are received

header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderMotoResponse.Order.order.code)

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}

request_refun_moto_order

requestRefunOrderMoto

Authorizations:
api_key
header Parameters
RV-SESS-T
required
string

auth token

Request Body schema:
order_code
required
string

Unique identifier of the order. (OrderResponse.Order.order.code)

amount
required
number <integer>

amount in cents that is required to return

Responses

Request samples

Content type
{
  • "order_code": "wgByP.288",
  • "amount": 1020
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "success.",
  • "result": {
    }
}