Create Collected Payment Request

Create Collected Payment Request.

Request

Request header:

POST https://api.ipaymy.com/v2/payment_collection_request
Host: api.ipaymy.com
Accept: application/json

Request body:

{
    "purpose": "rent | salary | invoice | collection | collection_with_commission",
    "requests": [
        {
            "payment_request_id": 0,
            "payees": [
                {
                    "id": 0,
                    "bank_id": 0,
                    "currency_id": 0,
                    "account_number": "",
                    "recipient_name": "",
                    "comments": "",
                    "uid": "",
                    "due_date": "",
                    "payment_description": "",
                    "gross_amount": 0,
                    "supporting_documents": [
                        ""
                    ],
                    "invoice_date": "",
                    "terms": "",
                    "items": [
                        {
                            "name": "",
                            "discount": 0.0,
                            "discount_type": "percentage | amount",
                            "tax_name": "",
                            "tax_rate": 0.0,
                            "quantity": 0,
                            "unit_price": 0,
                            "tax_id": 0,
                            "item_id": 0
                        }
                    ],
                    "po_number": ""0,
                    "invoice_number_digits": 0,
                    "commission_rate": 0,
                    "commission_fee": 0,
                    "is_secondary": true,
                    "bank_bsb_id": 0,
                    "bank_code": "",
                    "bsb_code": "",
                    "incentives": [
                        {
                            "incentive_type_id": 0,
                            "rate": 0,
                            "fee": 0,
                            "email_id": 0,
                            "deadline": "",
                            "installment_plan_number": 0
                        }
                    ]
                }
            ],
            "payer_id": 0,
            "fee_payer": 0,
            "int_fee_payer": 0,
            "crypto_rate_payer": 0,
            "requester_national_rate": 0,
            "requester_oversea_rate": 0,
            "requester_crypto_rate": 0,
            "requester_rates": [
                {
                    "brand_id": 0,
                    "national": 0,
                    "international": 0,
                    "fee_payer": 0,
                    "int_fee_payer": 0,
                    "crypto_rate": 0,
                    "crypto_rate_payer": 0
                }
            ],
            "to_create_or_upload_invoice": "create | upload | sms | none",
            "term_and_condition": "",
            "invoice_note": "",
            "mail_reply_to": "",
            "mail_to": "",
            "mail_cc": "",
            "mail_message": "",
            "calculate_method": "discount_tax_all_item | discount_all_item | discount_tax_per_item"
        }
    ],
    "draft": true,
    "required_verification_fields": [
        ""
    ],
    "step": 0
}

Response

Response body:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb3IiOjQwMCwidWlkIjo1NTc4MywidiI6IjF8MzM2MDIzfDU1NzgzfF98MXwxfDF8MXw4MnwxfDF8MXxffDJ8MjI5MTk4fDB8In0.30Ol9kB4L-2IE4aEct_uMQCSSSsRY6rRfna-kHGmnuw"
}

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.