---
title: "retry payment"
method: POST
path: "/payto/payments/{payment_uid}/retry"
tags: ["Payments"]
---

# retry payment

`POST /payto/payments/{payment_uid}/retry`

## Request

- Base URL: `https://api.sandbox.zeptopayments.com`
- URL: `https://api.sandbox.zeptopayments.com/payto/payments/{payment_uid}/retry`
- Auth: HTTP bearer

Retry a failed payment as long as it has failed due to a [retryable]https://docs.zeptopayments.com/reference/payto-reason-codes) reason as indicated by the `retryable` boolean field within the payment's failure object. Payments may be retried up to 10 times while within the related agreement's validity begin and end dates. Additionally, payments can only be retried 5 times within a 24 hour period (the first submission is included in this count).

## Headers

- `Zepto-API-Version` string

## Request body

- PaytoRetryPaymentRequest
  - `creditor` object: Who and where the payment is sent to. Optional - defaults to creditor details from agreement (if present), or the existing creditor details from the payment.
    - `party_name` string, required: The name of the creditor party must accurately represent the creditor party and may be the same as the ultimate_party_name.
    - `ultimate_party_name` string, nullable, required: The ultimate creditor name must accurately represent the ultimate creditor party and may be the same as the party_name.
    - `account_identifier` PaytoAccountIdentifier, required: An identifier representing the parties account
      - `type` 'bban' | 'alias_phone' | 'alias_email' | 'alias_abn' | 'alias_organisation_identifier', required
      - `value` union, required
        - string: A branch code (BSB) and account number separated with a hyphen
        - string: A PayID email alias
        - string: A PayID phone alias. e.g. +61-411222333
        - string: A PayID ABN alias
        - string: A PayID organisation identifier alias
    - `payment_account_uid` string: The uid of a payment account registered via the Counterparties API, identifying the party behind the nominated account. Its account identifier must match account_identifier and its party_name must match the creditor ultimate_party_name, ignoring case. A creditor supplied here replaces the payment's creditor in full: omitting payment_account_uid leaves the payment without one, and when the agreement names a payment account the uid must match it.
  - `sandbox` object: SANDBOX ONLY: Parameter that allows you to simulate certain scenarios in regards to the payment retry to aid integrators while testing their control flows.
    - `simulate` 'auto_settle' | 'requires_investigation' | 'investigate_and_settle' | 'investigate_and_fail' | 'insufficient_funds' | 'creditor_account_type_not_supported' | 'creditor_account_closed' | 'debtor_account_closed' | 'financial_infrastructure_unavailable' | 'debtor_alias_not_found' | 'creditor_alias_not_found' | 'alias_resolution_service_unavailable', required
    - `delay` integer: An optional attribute that will delay the requested simulation by the given amount of seconds. If `delay` is not provided (default behaviour), the simulated action will happen instantly.

## Response `202`

successful

## Other responses

- `400`: Bad Request
- `401`: unauthorized
- `403`: forbidden
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/zeptopayments/apis/zepto-payto-api.md) - [All operations](https://skmtc.dev/zeptopayments/apis/zepto-payto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeptopayments/apis/zepto-payto-api/revisions/dfc64507b23c?raw)