UseePay API
  1. Mandates
UseePay API
  • Introduction
  • Product Overview
  • Authentication
  • Errors
  • Changelog
  • Integration
    • Get started with online payments
    • Get started with subscriptions
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • Update a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • List all payment intents
      GET
  • Customers
    • Create a customer
      POST
    • Retrieves a customer
      GET
    • Update a customer
      POST
    • List all customers
      GET
  • Subscriptions
    • Create a subscription
      POST
    • Retrieves a subscription
      GET
    • Update a subscription
      POST
    • List all subscriptions
      GET
    • Cancel a subscription
      POST
  • Invoices
    • Create a invoice
    • Retrieves a invoice
    • Update a invoice
    • List all invoices
    • Pay a invoice
  • Payment Methods
    • Create a payment method
    • Retrieves a payment method
    • Update a payment method
    • List all payment methods
  • Mandates
    • Create a mandate
      POST
    • Retrieves a mandate
      GET
    • Update a mandate
      POST
    • List all mandates
      GET
  • Refunds
    • Create a refund
    • Retrieves a refund
    • Update a refund
    • List all refunds
  • Webhooks
    • Webhook envents
    • Create a webhook
    • Retrieves a webhook
    • Update a webhook
    • List all webhooks
  • Payment Links
    • Create a payment link
    • Retrieves a payment link
    • Update a payment link
    • List all payment links
  • Embedded Checkout
    • Payment Elements
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  1. Mandates

Create a mandate

POST
/api/v1/mandates/create

Request

Header Params

Body Params application/json

Example
{
    "customer_id":"{{customer-id}}"
    ,"payment_intent_id":"{{payment-intent-id}}"
    ,"customer_acceptance":{
        "type":"online"
        ,"accepted_at":"2024-10-06T10:56:21Z"
        ,"online":{
            "ip_address":"192.168.12.1"
            ,"user_agent":"user agent"
        }
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi1.uat.useepay.com/api/v1/mandates/create' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id":"cus_1JA7UDDQG3800"
    ,"payment_intent_id":"1012411211459019141"
    ,"customer_acceptance":{
        "type":"online"
        ,"accepted_at":"2024-10-06T10:56:21Z"
        ,"online":{
            "ip_address":"192.168.12.1"
            ,"user_agent":"user agent"
        }
    }
}'

Responses

🟢200Success
application/json
Body

Example
{
    "id": "man_1JARUC40K0800",
    "customer_id": "{{customer-id}}",
    "payment_intent_id": "{{payment-intent-id}}",
    "customer_acceptance": {
        "type": "online",
        "accepted_at": "2024-10-06T10:56:21Z",
        "online": {
            "ip_address": "192.168.12.1",
            "user_agent": "user agent"
        }
    },
    "merchant_no": "500000000007264",
    "app_id": "www.pay.com",
    "create_at": "2024-10-25T07:14:09Z",
    "modify_at": "2024-10-25T07:14:09Z"
}
Modified at 2024-10-25 09:24:32
Previous
List all payment methods
Next
Retrieves a mandate
Built with