Payments API
Retrieves the info status of a specific payment.
Basic authentication Username: apiKeyID, Password: apiSecret
txn_Zz6xMSJsokwqSuccessful response with payment info
Unauthorized
Payment not found
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": "+1234567890",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"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"
}
}
}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.
Basic authentication Username: apiKeyID, Password: apiSecret
txn_Zz6xMSJsokwqJohnSmithSuccessful response with new payment id.
Payment not eligible for fallback. This will occur if the original a payment is not eleigible for cancelation.
Unauthorized
Payment not found
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.
Cancels a specific payment.
Basic authentication Username: apiKeyID, Password: apiSecret
txn_Zz6xMSJsokwqPayment successfully canceled
Payment not eligible for cancelation
Unauthorized
Payment not found
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.
Cancels digital payment and creates new digital payment with updates details. The new payment retains the notes and idepmpotency key of the old payment. Email, phone, first_name, and last_name must be re-specified. Amount can't be amended.
Basic authentication Username: apiKeyID, Password: apiSecret
txn_Zz6xMSJsokwqThe name of the user
JohnSmith[email protected]+1234567890Successful response with new payment id.
Payment not eligible for amendment. This will occur if the original payment is not eleigible for cancelation.
Unauthorized
Payment not found
POST /v1/payments/{payment_id}/amend HTTP/1.1
Host: api-sandbox.todaypay.me
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 205
{
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"phone_number": "+1234567890",
"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"
}
}Last updated