Create recurring payment

Creates a payment for a recurring account. This operation is synchronous and does not require the user to be involved. The payment result will be returned directly.

Create recurring payment flow
info

The recurring account must be activated through the client API before payments can be made. Get recurring account to verify that the account status is ACTIVE.

Request

  • your-authorization should be replaced with your Authorization header, see Access
  • your-user-id in the URI, should be replaced with your identifier of the user
  • accountId in the request body, id for the recurring account to use for the payment
Copy
Copied
POST /v1/users/{your-user-id}/recurring-payments

Content-Type: application/json
Accept: application/json
Authorization: $(your-authorization)
Request Body schema: application/json

Payment details

object (RecurringPaymentCreateDto)
accountId
string

Your recurring account ID

amount
number
purchaseReference
string
application/json
{
  • "payment": {
    }
}

Response

Success

Response Schema: application/json
object (RecurringPaymentDto)
id
string
merchantId
string
accountId
string
amount
number
currency
string
purchaseReference
string
application/json
{
  • "payment": {
    }
}
Error responses

Please refer to our HTTP response codes and Error codes to learn what error responses you may expect from the API.

Example

Try it
Loading...