API

API

    ›Response

    Getting Started

    • Introduction

    Authencation

    • Register
    • Login
    • Password reset
    • Resend Mobile Verification
    • Resend Email Verification

    Profile

    • Get profile
    • Update profile
    • Change email
    • Change password
    • List companies

    Dashboard

    • Get dashboard
    • Get recent activity
    • List cards

    Pay

    • List payments
    • Get payment detail
    • List schedules
    • List schedules compact
    • Get schedule detail
    • List payees
    • Get payee details
    • Update favorite payment
    • Cancel Schedule

    Fetch

    • List payment collections
    • List payers
    • Get payer details

    Payment Collection

    • Resend Collected Payment Request
    • Create Collected Payment Request
    • Validate Collected Payment Request
    • Delete Collected Payment
    • Create Collected Tax Payment
    • Update Collected Tax Payment
    • Create Collected Invoice Item
    • Update Collected Invoice Item
    • Create Payment Collection Payer
    • Update Payment Collection Payer
    • Delete Payment Collection Payer
    • Create Collected Account
    • Update Collected Account
    • Update Collected Account Additional Setting
    • Update Collected Account Other Setting
    • Update Collected Account Draft Setting
    • User Mark Payment As Completed

    Coupon

    • Apply Coupon
    • Remove Coupon Usage

    Response

    • Response

    Other

    • Upload Files
    • Upload Files Public
    • Validate And Search UEN
    • Validate Amount

    Webhook

    • Mailgun Failed Email Webhoob
    • Twilio message webhook
    • Mailgun Receive Email Webhook
    • Active Campaign Import Contact Webhook
    • WP Webhook
    • Webhook Finmo Payout
    • Verify Email
    • 3ds Callback
    • 3ds Frame Post
    • 3ds Payment Update Callback
    • Resend Verify Email With Redirection
    • TripleA Refund Callback

    Admin

    • Add Coupons For Admin
    • Edit Coupons For Admin
    • Add Localized Strings For Admin
    • Update Localized Strings For Admin
    • Mark Payment As Completed For Admin
    • Admin Deposit International Payment
    • Bulk Mark Payments As Completed For Admin
    • Request Login
    • Admin Fully Refund A Payment
    • Admin Hold Payment
    • Admin Partial Refund A Payment Fee
    • Admin Partial Refund A Payment Principal
    • Admin Partial Refund Payment Principal With Fees
    • Admin Process Refund Payment
    • Admin Expedite Payment
    • Admin Assign Account Manager
    • Admin Resend Verify Email
    • Admin Change Status Collected Account
    • Admin Add Document Collected Account
    • Admin Cancel Payments
    • Admin Edit Payment Payee Request
    • Admin Add Or Update UEN
    • Admin Delete UEN
    • Upload Admin Files
    • Block User For Admin
    • Un Block User For Admin
    • Admin Change Status Comply Advantage Report
    • Handle Admin Update Payout
    • Admin Payments For Approval

    API Response

    200 Success Response

    Http status: 200

    {
        data: {},
        error: 0
    }
    

    422 Logic Error Response

    Http status: 422

    {
        "errors": {
            "fields": {
                [field_name: string]: string[]
            },
            "form": string[]
        }
    }
    

    Example Response Error:

    {
        "errors": {
            "fields": {
              "foo": ["INVALID_NUMBER"]
            },
            "form": ["SOME_ERROR"]
        }
    }
    

    fields represents the error related to a specific field sent in the request payload.

    form represents a logic error

    Error code definition

    401 Unauthorized Error Response

    Http status: 401 You'll need to authenticate to get a valid new access token.

    ← Remove Coupon UsageUpload Files →
    Copyright © 2024 ipaymy.com