---
updatedAt: 2026-06-03T10:08:49.000Z
agentTools:
  projectIndex: https://snaprefund.readme.io/llms.txt
---

# Send pending payment

Trigger a pending payment notification to be sent to the given email address. This pending payment will behave in the same way a payment sent manually through the SnapRefund web app behaves. ie) The recipient will receive a notification email for the payment containing a deep link to the Pending Payment. Once inside, the recipient will select their payout method of choice from a list of all of the available payment options for the given sender. If the sender has at least one branding profile, brandingProfileId is required and must be linked to the selected senderBankId. If the sender has no branding profiles, omit brandingProfileId and the payment branding will be null.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/public/payments": {
      "post": {
        "operationId": "PublicApiPaymentsController_createPayment",
        "summary": "Send pending payment",
        "description": "Trigger a pending payment notification to be sent to the given email address. This pending payment will behave in the same way a payment sent manually through the SnapRefund web app behaves. ie) The recipient will receive a notification email for the payment containing a deep link to the Pending Payment. Once inside, the recipient will select their payout method of choice from a list of all of the available payment options for the given sender. If the sender has at least one branding profile, brandingProfileId is required and must be linked to the selected senderBankId. If the sender has no branding profiles, omit brandingProfileId and the payment branding will be null.",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "nullable": true
                  },
                  "recipientEmail": {
                    "type": "string"
                  },
                  "amount": {
                    "type": "string",
                    "format": "number"
                  },
                  "memo": {
                    "type": "string",
                    "minLength": 1
                  },
                  "senderBankId": {
                    "type": "string",
                    "nullable": true
                  },
                  "approversEmails": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "brandingProfileId": {
                    "type": "number",
                    "nullable": true,
                    "description": "Required only when the sender has at least one branding profile. Must belong to the sender and be linked to senderBankId. Use /api/public/my-info/branding-profiles to retrieve values. Omit this field when the sender has no branding profiles."
                  }
                },
                "required": [
                  "memo"
                ]
              }
            },
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "nullable": true
                  },
                  "recipientEmail": {
                    "type": "string"
                  },
                  "amount": {
                    "type": "string",
                    "format": "number"
                  },
                  "memo": {
                    "type": "string",
                    "minLength": 1
                  },
                  "senderBankId": {
                    "type": "string",
                    "nullable": true
                  },
                  "approversEmails": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "brandingProfileId": {
                    "type": "number",
                    "nullable": true,
                    "description": "Required only when the sender has at least one branding profile. Must belong to the sender and be linked to senderBankId. Use /api/public/my-info/branding-profiles to retrieve values. Omit this field when the sender has no branding profiles."
                  },
                  "claimNumber": {
                    "type": "string",
                    "maxLength": 255,
                    "nullable": true,
                    "description": "Optional claim reference shown alongside the payment in the dashboard, Transaction History, and exports."
                  }
                },
                "required": [
                  "memo"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          }
        },
        "tags": [
          "payments"
        ],
        "security": [
          {
            "Authorization": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "PRODUCTION",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://app.claimssnap.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "Authorization": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```