# Payment OpenAPI Specification

This is the documentation for the Ratepay Payment API v2. The API is still in development and subject to change. The documentation will evolve as the development of the API progresses.

Version: version 2

## Servers

Ratepay Integration Platform
```
https://api-integration.ratepay.com/transaction/management
```

Ratepay Production Platform
```
https://api.ratepay.com/transaction/management
```

## Security

### Bearer Authentication

For each request, a valid access token must be provided in the Authorization header. See [Authentication API](/docs/developer/authentication/authentication/) for obtaining a valid token.

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Payment OpenAPI Specification](https://docs.ratepay.com/_bundle/apis/payment/openapi/payment_api.yaml)

## Transaction management

### Authorize transaction

 - [POST /v2/transactions](https://docs.ratepay.com/apis/payment/openapi/payment_api/transaction-management/createtransaction.md): Perform an authorization request for a transaction.

### Retrieve transaction

 - [GET /v2/transactions/{ratepay_transaction_id}](https://docs.ratepay.com/apis/payment/openapi/payment_api/transaction-management/gettransaction.md): Retrieve attributes of an existing transaction including list of follow-up operations.

### Change transaction

 - [PATCH /v2/transactions/{ratepay_transaction_id}](https://docs.ratepay.com/apis/payment/openapi/payment_api/transaction-management/change.md): Change attributes of an existing transaction.

## Incremental authorization

### Retrieve all authorizations

 - [GET /v2/transactions/{ratepay_transaction_id}/authorizations](https://docs.ratepay.com/apis/payment/openapi/payment_api/incremental-authorization/getallauthorizations.md): Retrieve all authorization resources of an existing transaction including their attributes.

### Incrementally authorize transaction

 - [POST /v2/transactions/{ratepay_transaction_id}/authorizations](https://docs.ratepay.com/apis/payment/openapi/payment_api/incremental-authorization/incrementalauthorizationtransaction.md): Increase the amount of a previously authorized transaction

### Retrieve an authorization

 - [GET /v2/transactions/{ratepay_transaction_id}/authorizations/{ratepay_authorization_id}](https://docs.ratepay.com/apis/payment/openapi/payment_api/incremental-authorization/getsingleauthorization.md): Retrieve an authorization resource of an existing transaction including its attributes.

## Cancellation

### Retrieve all cancellations

 - [GET /v2/transactions/{ratepay_transaction_id}/cancellations](https://docs.ratepay.com/apis/payment/openapi/payment_api/cancellation/getallcancellations.md): Retrieve all cancellation resources of an existing transaction including their attributes.

### Cancel transaction

 - [POST /v2/transactions/{ratepay_transaction_id}/cancellations](https://docs.ratepay.com/apis/payment/openapi/payment_api/cancellation/canceltransaction.md): Cancel a previously authorized transaction

### Retrieve a cancellation

 - [GET /v2/transactions/{ratepay_transaction_id}/cancellations/{ratepay_cancellation_id}](https://docs.ratepay.com/apis/payment/openapi/payment_api/cancellation/getsinglecancellation.md): Retrieve a cancellation resource of an existing transaction including its attributes.

## Capture

### Retrieve all captures

 - [GET /v2/transactions/{ratepay_transaction_id}/captures](https://docs.ratepay.com/apis/payment/openapi/payment_api/capture/getallcaptures.md): Retrieve all capture resources of an existing transaction including their attributes.

### Capture transaction

 - [POST /v2/transactions/{ratepay_transaction_id}/captures](https://docs.ratepay.com/apis/payment/openapi/payment_api/capture/capturetransaction.md): Capture a previously authorized transaction

### Retrieve a capture

 - [GET /v2/transactions/{ratepay_transaction_id}/captures/{ratepay_capture_id}](https://docs.ratepay.com/apis/payment/openapi/payment_api/capture/getsinglecapture.md): Retrieve a capture resource of an existing transaction including its attributes.

## Shipping information

### Add shipping information

 - [POST /v2/transactions/{ratepay_transaction_id}/captures/{ratepay_capture_id}/shipping-information](https://docs.ratepay.com/apis/payment/openapi/payment_api/shipping-information/addshippinginformation.md): Add shipping information to previously captured transaction

## Refund

### Retrieve all refunds

 - [GET /v2/transactions/{ratepay_transaction_id}/refunds](https://docs.ratepay.com/apis/payment/openapi/payment_api/refund/getallrefunds.md): Retrieve all refund resources of an existing transaction including their attributes.

### Refund transaction

 - [POST /v2/transactions/{ratepay_transaction_id}/refunds](https://docs.ratepay.com/apis/payment/openapi/payment_api/refund/refundtransaction.md): Refund a previously authorized and captured transaction

### Retrieve a refund

 - [GET /v2/transactions/{ratepay_transaction_id}/refunds/{ratepay_refund_id}](https://docs.ratepay.com/apis/payment/openapi/payment_api/refund/getsinglerefund.md): Retrieve a refund resource of an existing transaction including its attributes.