Payments API

Get info and status of payment.

get

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

/v1/payments/{payment_id}

Retrieves the info status of a specific payment.

Authorizations

basicAuth

AuthorizationstringRequired

Basic authentication Username: apiKeyID, Password: apiSecret

Path parameters

payment_idstringRequiredExample: txn_Zz6xMSJsokwq

Responses

200

Successful response with payment info

application/json

401

Unauthorized

404

Payment not found

get

/v1/payments/{payment_id}

HTTPcURLJavaScriptPython

GET /v1/payments/{payment_id} HTTP/1.1
Host: api-sandbox.todaypay.me
Authorization: Basic username:password
Accept: */*

{
  "status": "success",
  "data": {
    "id": "txn_Zz6xMSJsokwq",
    "amount": "1000.00",
    "status": "SUCCESS",
    "method": "DIGITAL",
    "cancellable": true,
    "phone_number": "[phone]",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "mailing_address": {
      "line_1": "text",
      "line_2": "text",
      "state": "NY",
      "city": "text",
      "zip": "text"
    },
    "idempotency_key": "abc123-unique-key",
    "datetime_initiated": "2025-03-12T14Z",
    "notes": "003993849393",
    "claimed": true,
    "datetime_claimed": "2025-05-12T14Z",
    "claim_metadta": {
      "ip_address": "192.168.1.1",
      "device_id": "92dOtZmtCuWlZ6nryeZU2iX7TmZPguoB"
    }
  }
}

Get info and status of payment.

post

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

/v1/payments/{payment_id}/fallback

Retrieves the info status of a specific payment.

Authorizations

basicAuth

AuthorizationstringRequired

Basic authentication Username: apiKeyID, Password: apiSecret

Path parameters

payment_idstringRequiredExample: txn_Zz6xMSJsokwq

Body

application/json

first_namestringRequired

The name of the user

Example: John

last_namestringOptional

The age of the user

Example: Smith

Responses

200

Successful response with new payment id.

application/json

400

Payment not eligible for fallback. This will occur if the original a payment is not eleigible for cancelation.

401

Unauthorized

404

Payment not found

post

/v1/payments/{payment_id}/fallback

HTTPcURLJavaScriptPython

POST /v1/payments/{payment_id}/fallback HTTP/1.1
Host: api-sandbox.todaypay.me
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "first_name": "John",
  "last_name": "Smith",
  "mailing_address": {
    "line_1": "text",
    "line_2": "text",
    "state": "NY",
    "city": "text",
    "zip": "text"
  }
}

{
  "status": "success",
  "data": {
    "old_payment_id": "idk",
    "new_payment_id": "idk"
  }
}

Payment Cancellation

Payments an be canceled as long as the customer has not logged in and claimed the payment. Cancellation requests will fail if a payment is not eligible for Cancellation.

Cancel Payment

delete

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

/v1/payments/{payment_id}

Cancels a specific payment.

Authorizations

basicAuth

AuthorizationstringRequired

Basic authentication Username: apiKeyID, Password: apiSecret

Path parameters

payment_idstringRequiredExample: txn_Zz6xMSJsokwq

Responses

200

Payment successfully canceled

application/json

400

Payment not eligible for cancelation

401

Unauthorized

404

Payment not found

delete

/v1/payments/{payment_id}

HTTPcURLJavaScriptPython

DELETE /v1/payments/{payment_id} HTTP/1.1
Host: api-sandbox.todaypay.me
Authorization: Basic username:password
Accept: */*

{
  "status": "success",
  "message": "Payment canceled"
}

Replace a payment with amended details

Payments an be amendment as long as the customer has not logged in and claimed the payment. Amend requests will fail if a payment is not eligible for cancelation.