---
title: "POST /api/v1/urltopay"
method: POST
path: "/api/v1/urltopay"
tags: ["UrlToPay"]
---

# POST /api/v1/urltopay

`POST /api/v1/urltopay`

## Request body

- CreateUrlToPayRequest
  - `customer` UrlToPayCustomer
    - `id` string, uuid
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `organizationName` string, nullable
    - `emailAddress` string, nullable
    - `mobilePhone` string, nullable
  - `taxAmount` number, double, required
  - `netAmount` number, double, required
  - `target` UrlToPayTarget, required
    - `type` 'UrlToPayAccountsReceivableTarget' | 'UrlToPayEventsTarget' | 'UrlToPayTransactionTarget', required
  - `merchantAccountId` integer, required

## Response `201`

Created

- UrlToPay
  - `id` string, uuid, required
  - `netAmount` number, double, required
  - `gratuityAmount` number, double, required
  - `status` 'Pending' | 'Canceled' | 'Complete', required
  - `target` UrlToPayTarget, required
    - `type` 'UrlToPayAccountsReceivableTarget' | 'UrlToPayEventsTarget' | 'UrlToPayTransactionTarget', required
  - `invoiceCreationTime` string, date-time, required
  - `urlToPayUri` string, nullable
  - `paymentDetails` UrlToPayPaymentDetails[], nullable
    - `type` 'UrlToPayCardPaymentDetails' | 'UrlToPayCashPaymentDetails', required
    - `approvalTimeStamp` string, date-time

## Other responses

- `400` — Bad Request
- `404` — Not Found

---

[API](https://skmtc.dev/centeredge/apis/advantage-api.md) · [All operations](https://skmtc.dev/centeredge/apis/advantage-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/centeredge/advantage-api/revisions/00cc7dde429b/schema)