Payments API

Get info and status of payment.

get

Retrieves the info status of a specific payment.

Authorizations

Path parameters

payment_idstringRequiredExample: txn_Zz6xMSJsokwq

Responses

get

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": "[e-mail]",
    "mailing_address": {
      "line_1": "165 W Broadway",
      "line_2": "Apt 5",
      "state": "NY",
      "city": "New York",
      "zip": "10005"
    },
    "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"
    }
  }
}

Initiate paper check fallback.

post

Cancels digital payment and creates new paper check payment. The new payment retains the notes and idepmpotency key of the old payment. First name, last name, and address must be re-specified on the request, even if included on the original payment. This request will fail if the orignal payment can't be canceled. The final result of a the operation is 1) orignal payment cancled and 2) a new paper-check payment is generated under a new payment id.

Authorizations

Path parameters

payment_idstringRequiredExample: txn_Zz6xMSJsokwq

Body

first_namestringRequired

The name of the user

Example: John

last_namestringRequired

The age of the user

Example: Smith

Responses

post

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: 149

{
  "first_name": "John",
  "last_name": "Smith",
  "mailing_address": {
    "line_1": "160 W Broadway",
    "line_2": "Apt 5",
    "state": "NY",
    "city": "New York",
    "zip": "10005"
  }
}

{
  "status": "success",
  "data": {
    "old_payment_id": "txn_Zz6xMSJsokwq",
    "new_payment_id": "txn_a035g4h567ga"
  }
}

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

Cancels a specific payment.

Authorizations

Path parameters

payment_idstringRequiredExample: txn_Zz6xMSJsokwq

Responses

delete

HTTPcURLJavaScriptPython

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

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