# Payments

Process payments with Ryft: authorizations, voids, captures, refunds etc.


## Create a new payment session

 - [POST /payment-sessions](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessioncreate.md): The start of the payment flow. Call this request once the customer has proceeded to checkout. Payment Sessions will auto-expire after several days if you don't take payment via the attempt-payment endpoint.

## Retrieve payment sessions between timestamps

 - [GET /payment-sessions](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessiongetbetweentimestamps.md): This is used to fetch payment sessions within a timestamp range, paginated

## Retrieve a payment session by Id

 - [GET /payment-sessions/{paymentSessionId}](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessionget.md): This is used to fetch a payment session by its paymentSessionId

## Update a payment session by Id

 - [PATCH /payment-sessions/{paymentSessionId}](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessionupdate.md): This is used to update a payment session by its Id. Note that this can only be used prior to a successful payment. Once payment has been approved, you cannot update a PaymentSession.

## Initiate a payment attempt

 - [POST /payment-sessions/attempt-payment](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessionattemptpayment.md): This is used to supply the card you have collected from the customer to pay for this payment session. Only call this endpoint from your front-end once you have collected the customer's card details.

If you want the lowest PCI burden we recommend using our embedded payment forms in place of this endpoint. This ensures Ryft store & transmit the card details securely from our servers rather than your own. Please contact your account manager if you want to opt for this.

## Continue taking payment after the initial attempt.

 - [POST /payment-sessions/continue-payment](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessioncontinuepayment.md): Submit additional data for payment sessions that require further action after using attempt-payment.
Note that our SDKs handle this step automatically.

## List payment transaction(s)

 - [GET /payment-sessions/{paymentSessionId}/transactions](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessionlisttransactions.md): List the transaction(s) for a particular payment

## Retrieve a payment transaction

 - [GET /payment-sessions/{paymentSessionId}/transactions/{paymentTransactionId}](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessiongettransactionbyid.md): Retrieve the transaction for a particular payment

## Manually capture a payment session

 - [POST /payment-sessions/{paymentSessionId}/captures](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessioncapturebyid.md): Call this endpoint to capture funds you have previously authorized on a payment session.
You can only call this endpoint when the payment session is in status Approved and its captureFlow value is Manual.

## Void a payment session

 - [POST /payment-sessions/{paymentSessionId}/voids](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessionvoidbyid.md): Call this endpoint to void a payment session currently awaiting manual capture.
This will reverse the amount authorized on the payment and return it to the customer. If voided on the same-day, the transaction will not show up on the customer's card statement(s).
You can only call this endpoint when the payment session is in status Approved and its captureFlow value is Manual.

## Refund a payment

 - [POST /payment-sessions/{paymentSessionId}/refunds](https://developer.ryftpay.com/documentation/api/reference/openapi/payments/paymentsessioncreaterefund.md): Use this endpoint to refund an already captured payment session. Unlike voids, which are typically completed in minutes, refunds can take several days to be cleared by the card schemes.