API

API

    ›Profile

    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 profile

    Request

    Request header:

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

    Response

    Response body:

    {
      "data": {
        "available_acquirers": [
          {
            "id": 82,
            "name": "Worldpay",
            "label": "CARD_BRAND_VISA_LABEL",
            "card_brand_id": 2,
            "is_dynamic_mcc": false,
            "is_international_payment": true
          },
          {
            "id": 82,
            "name": "Worldpay",
            "label": "CARD_BRAND_MASTERCARD_LABEL",
            "card_brand_id": 3,
            "is_dynamic_mcc": false,
            "is_international_payment": true
          },
          {
            "id": 4,
            "name": "Stripe",
            "label": "CARD_BRAND_CHINA_UNIONPAY_LABEL",
            "card_brand_id": 5,
            "is_dynamic_mcc": false,
            "is_international_payment": false
          },
          {
            "id": 82,
            "name": "Worldpay",
            "label": "CARD_BRAND_AMEX_LABEL",
            "card_brand_id": 4,
            "is_dynamic_mcc": false,
            "is_international_payment": false
          }
        ],
        "can_access_crypto_payment": true,
        "created_at": "2021-06-03T07:08:22.662376Z",
        "email": "example@ipaymy.com",
        "first_name": "Alice",
        "last_name": "Bob",
        "has_active_program": false,
        "has_id_verification": false,
        "has_incorporation_date": true,
        "has_wallex_payment": true,
        "hmac": "56487e449ef530bdddcda479aa15390f468e769e6abda6be1c898286ee9a4303",
        "mobile_country_id": 1,
        "mobile_number": "1234567",
        "prefilled_company": null,
        "setting_required": {
          "required": "000010000100000001001000000000001000",
          "values": {
            "be_paid_tnc_confirmation": false,
            "credit_program_offer_v1_enabled": false,
            "payment_interest": "Both",
            "referrer": "https://sg.ipaymy.com/login",
            "register_url": "https://sg.ipaymy.com/register"
          }
        },
        "wallex_kyc_status": 7
      },
      "error": 0
    }
    

    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.
    ← Resend Email VerificationUpdate profile →
    Copyright © 2024 ipaymy.com