Resume a payment batch's consent
POST/api/v1/payment_batches/:id/consent_session
Resumes the hosted consent of a hosted_consent batch that submit already handed over, and answers 200: nothing is created. Every call asks the payment provider again - an open consent gets a fresh consent_url, and a consent the provider has since accepted, timed out or refused moves the batch accordingly. It never sends the batch a second time. A batch whose consent is already resolved is answered from its current state without asking the provider. The body carries a bearer capability, so it is sent with Cache-Control: no-store, and this endpoint takes no Idempotency-Key: one that is sent is ignored, and nothing is stored or replayed.
Request
Responses
- 200
- 403
- 404
- 422
- 429
The consent, as the provider reports it now.
The token lacks the write scope.
No payment batch with this id is reachable by the token's grants.
batch_not_submittable: there is no consent to resume - the batch has not been handed over yet (call submit first), or it is a sepa_file batch (use sepa_export). The provider was not asked.
rate_limited: this application called consent_session on this batch more than 6 requests per minute. Nothing was done and the provider was not asked; retry after Retry-After seconds. Other batches, and other applications, are counted separately.
Response Headers
Seconds to wait before retrying.