Offer instarefund®

Integrators & Partners can trigger instarefund via API using the following endpoint

Create an instarefund® offer

post

https://api-sandbox.todaypay.mehttps://api.todaypay.mehttps://api-staging.todaypay.tech

/v2/instarefund/offers

instarefund® offer for a customer's return order.

Authorizations

basicAuth

AuthorizationstringRequired

Basic authentication Username: apiKeyID, Password: apiSecret

Body

application/json

idempotency_keystringRequired

Unique key to ensure idempotent request processing. Repeated requests with the same key must return the same response and must not create duplicate refund offers.

Example: return_9f3a2c

Responses

200

Instarefund offer successfully created

application/json

400

Bad request - invalid input

401

Unauthorized

post

/v2/instarefund/offers

HTTPcURLJavaScriptPython

POST /v2/instarefund/offers HTTP/1.1
Host: api-sandbox.todaypay.me
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 382

{
  "idempotency_key": "return_9f3a2c",
  "customer": {
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "[phone]",
    "email": "[email protected]",
    "address": {
      "line1": "1600 Amphitheatre Parkway",
      "line2": "Suite 200",
      "city": "Mountain View",
      "state": "CA",
      "postal_code": "94043-1351",
      "country": "US"
    }
  },
  "items": [
    {
      "merchant_name": "nike",
      "merchant_order_id": "Z987654",
      "amount_in_cents": 12999
    }
  ]
}

{
  "status": "success",
  "data": {
    "id": "iro_a1b2c3",
    "idempotency_key": "return_9f3a2c",
    "expires_at": "2025-01-16T14:30:00Z"
  }
}