API

API

    ›Pay

    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

    Get payee details

    Request

    Request header:

    GET https://api.ipaymy.com/v2/payees/:payee_id
    Host: api.ipaymy.com
    Accept: application/json
    Authorization: Bearer your_access_token
    

    Path Parameters:

    payee_id:

    • Description: Unique payee id from your list payees
    • Type: number

    Response

    Response body:

    {
      "data": {
        "account_number": "100000000000000",
        "amount": 300,
        "bank": 6,
        "comments": "Test",
        "country_id": 1,
        "currency_id": 1,
        "data": {
          "postal_code": "1234",
          "address": "Test",
          "supporting_documents": [
            "tenancy_agreement__1677834720__4712__aXBheW15LnBuZw=="
          ],
          "recipient_contact_name": "",
          "recipient_email": "",
          "recipient_mobile": "",
          "registration_number": "",
          "id_type": "sg_postal",
          "id_number": "%!s(*string=0xc00027dd80)__awd",
          "should_notify_recipient_initiated": false,
          "supplier_opt_in": null,
          "bank_country_id": 1,
          "first_name": null,
          "last_name": null,
          "bank_raw_name": "Bank of China",
          "bank_account_holder_name": null,
          "bank_raw_swift_code": "BKCHSGSGXXX",
          "unit_number": "awd",
          "files": [
            {
              "key": "tenancy_agreement__1677834720__4712__aXBheW15LnBuZw==",
              "name": "ipaymy.png",
              "size": 4712,
              "url": "https://api-test.ipaymy.com/v2/files/tenancy_agreement__1677834720__4712__aXBheW15LnBuZw=="
            }
          ]
        },
        "id": 43447,
        "is_international": false,
        "is_unsupported": false,
        "is_wp_mcc": false,
        "name": "Test Crypto",
        "purpose_id": 1,
        "unsupported_message": ""
      }
    }
    

    Response codes:

    • 200: Good stuff, and the response body should be easy to parse.
    • 422: Typically malformed JSON, such as an integer in place of the required alphanumeric string, or a missing key. Check the response body for further details.
    ← List payeesUpdate favorite payment →
    Copyright © 2024 ipaymy.com