Apply for order reconciliation

💡

What you'll learn

How to create a reconciliation order on OwlPay

After creating orders on OwlPay, you must apply for the Order Reconciliation to transfer money to the vendor.

Refer to OwlPay payout flow for more details.

Create a reconciliation order

Use (POST) Create an order reconciliation to create a reconciliation order.

(POST) Create an order transfer

curl --request POST \
     --url https://api.owlpay.com/api/v1/platform/tunnel/orders_reconciliation \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {your api key}' \
     --header 'content-type: application/json' \
     --data '
{
     "application_order_serials": [
          "test_order_003",
          "test_order_004"
     ]
}
'

Response

{
    "data": [
        {
            "is_test": false,
            "is_allow_check": true,
            "is_allow_batch_finish": true,
            "group_uuid": "otrg_NVFyF99aEgw5HLXZNlDlJfS",
            "uuid": "otr_TI6c7y5jaZoxSCdDKLtd0B1",
            "object": "order_transfer",
            "uncheck_count": 2,
            "checked_count": 0,
            "currency": "TWD",
            "status": "unconfirm",
            "total": 30000,
            "original_total": 30000,
            "settled_total": 0,
            "settled_count": 0,
            "draft": {
                "approve_total": 0,
                "reject_total": 0,
                "uncheck_total": 30000,
                "approve_count": 0,
                "reject_count": 0,
                "uncheck_count": 2
            },
            "settled": {
                "total": 0,
                "approve_total": 0,
                "reject_total": 0,
                "approve_count": 0,
                "reject_count": 0
            },
            "finished_at": null,
            "apply_user": {
                "object": "order_transfer.apply_user",
                "owlting_uuid": null,
                "name": "OwlPay New Company",
                "email": null,
                "guard": "application"
            },
            "orders": [
                {
                    "order_token": "ord_5559bc41f967048a9a3179ee7aa5d8a395d1b6af8decfc216608dc72d0b0fb21",
                    "object": "order",
                    "uuid": "ord_5559bc41f967048a9a3179ee7aa5d8a395d1b6af8decfc216608dc72d0b0fb21",
                    "status": "owlpay.order_unconfirmed",
                    "status_group": "submit",
                    "is_checked": false,
                    "is_allow_transfer": false,
                    "is_allow_close": false,
                    "is_allow_confirmed": false,
                    "is_allow_correction": false,
                    "deny_transfer_reasons": [],
                    "order_serial": "test_order_004",
                    "application_order_serial": "test_order_004",
                    "application_order_created_at": "2022-11-29T07:39:20+00:00",
                    "allow_transfer_time_at": "2022-11-29T07:39:20+00:00",
                    "last_reject_transfer_reason": null,
                    "is_rejected": false,
                    "currency": "TWD",
                    "total": 20000,
                    "original_total": 20000,
                    "display_currency": "TWD",
                    "created_at": "2022-11-29T07:39:20+00:00",
                    "updated_at": "2022-11-29T07:41:10+00:00",
                    "vendor_uuid": "ven_4a1vlHE3rqPpSZQP5fQFIRc",
                    "vendor_name": "owlpay vendor through api",
                    "application_vendor_uuid": "test vendor",
                    "is_vendor_kyc_passed": true,
                    "description": "This order is created by API too",
                    "meta_data": {},
                    "status_logs": [
                        {
                            "name": "可申請對帳",
                            "is_current": false,
                            "updated_time_at": "2022-11-29T07:39:20+00:00"
                        },
                        {
                            "name": "待審核",
                            "is_current": true,
                            "updated_time_at": "2022-11-29T07:41:10+00:00"
                        },
                        {
                            "name": "審核通過",
                            "is_current": false,
                            "updated_time_at": null
                        },
                        {
                            "name": "等待付款",
                            "is_current": false,
                            "updated_time_at": null
                        },
                        {
                            "name": "付款成功",
                            "is_current": false,
                            "updated_time_at": null
                        }
                    ],
                    "order_extras": {
                        "inclusive": {
                            "total": 0,
                            "items": []
                        },
                        "exclusive": {
                            "total": 0,
                            "items": []
                        }
                    },
                    "closed_transfer_reason": null,
                    "procedures": [
                        {
                            "role_name": "平台",
                            "role": "application",
                            "guard": "platform",
                            "name": "",
                            "status": "none",
                            "count": 0
                        },
                        {
                            "role_name": "供應商",
                            "role": "owner",
                            "guard": "vendor_user",
                            "name": "owlpay vendor through api ven_4a1vlHE3rqPpSZQP5fQFIRc",
                            "status": "none",
                            "count": 0
                        }
                    ],
                    "draft_audits": {
                        "is_need_correction": false,
                        "is_need_check": false,
                        "is_with_me": false,
                        "need_correction": 0,
                        "need_check": 0,
                        "confirmed": 0,
                        "done": 0,
                        "total": 2
                    },
                    "order_transfer_uuid": "otr_TI6c7y5jaZoxSCdDKLtd0B1",
                    "accounting_uuid": null,
                    "vendor_status": "approved",
                    "is_has_need_correction": false,
                    "import_uuid": null,
                    "is_from_import": false,
                    "payout_gateways": [
                        {
                            "key": "MyB2B_batch_payout",
                            "name": "國泰世華全球企網銀 (Global MyB2B)"
                        }
                    ],
                    "creator_name": null,
                    "creator_type": null
                },
                {
                    "order_token": "ord_3fde4d7a1574c6bc4d60ca2a504d42b1bd6bb6a25be84196dce99bc18eeb2039",
                    "object": "order",
                    "uuid": "ord_3fde4d7a1574c6bc4d60ca2a504d42b1bd6bb6a25be84196dce99bc18eeb2039",
                    "status": "owlpay.order_unconfirmed",
                    "status_group": "submit",
                    "is_checked": false,
                    "is_allow_transfer": false,
                    "is_allow_close": false,
                    "is_allow_confirmed": false,
                    "is_allow_correction": false,
                    "deny_transfer_reasons": [],
                    "order_serial": "test_order_003",
                    "application_order_serial": "test_order_003",
                    "application_order_created_at": "2022-11-29T07:39:20+00:00",
                    "allow_transfer_time_at": "2022-11-29T07:39:20+00:00",
                    "last_reject_transfer_reason": null,
                    "is_rejected": false,
                    "currency": "TWD",
                    "total": 10000,
                    "original_total": 10000,
                    "display_currency": "TWD",
                    "created_at": "2022-11-29T07:39:20+00:00",
                    "updated_at": "2022-11-29T07:41:10+00:00",
                    "vendor_uuid": "ven_4a1vlHE3rqPpSZQP5fQFIRc",
                    "vendor_name": "owlpay vendor through api",
                    "application_vendor_uuid": "test vendor",
                    "is_vendor_kyc_passed": true,
                    "description": "This order is created by API",
                    "meta_data": {},
                    "status_logs": [
                        {
                            "name": "可申請對帳",
                            "is_current": false,
                            "updated_time_at": "2022-11-29T07:39:20+00:00"
                        },
                        {
                            "name": "待審核",
                            "is_current": true,
                            "updated_time_at": "2022-11-29T07:41:10+00:00"
                        },
                        {
                            "name": "審核通過",
                            "is_current": false,
                            "updated_time_at": null
                        },
                        {
                            "name": "等待付款",
                            "is_current": false,
                            "updated_time_at": null
                        },
                        {
                            "name": "付款成功",
                            "is_current": false,
                            "updated_time_at": null
                        }
                    ],
                    "order_extras": {
                        "inclusive": {
                            "total": 0,
                            "items": []
                        },
                        "exclusive": {
                            "total": 0,
                            "items": []
                        }
                    },
                    "closed_transfer_reason": null,
                    "procedures": [
                        {
                            "role_name": "平台",
                            "role": "application",
                            "guard": "platform",
                            "name": "",
                            "status": "none",
                            "count": 0
                        },
                        {
                            "role_name": "供應商",
                            "role": "owner",
                            "guard": "vendor_user",
                            "name": "owlpay vendor through api ven_4a1vlHE3rqPpSZQP5fQFIRc",
                            "status": "none",
                            "count": 0
                        }
                    ],
                    "draft_audits": {
                        "is_need_correction": false,
                        "is_need_check": false,
                        "is_with_me": false,
                        "need_correction": 0,
                        "need_check": 0,
                        "confirmed": 0,
                        "done": 0,
                        "total": 2
                    },
                    "order_transfer_uuid": "otr_TI6c7y5jaZoxSCdDKLtd0B1",
                    "accounting_uuid": null,
                    "vendor_status": "approved",
                    "is_has_need_correction": false,
                    "import_uuid": null,
                    "is_from_import": false,
                    "payout_gateways": [
                        {
                            "key": "MyB2B_batch_payout",
                            "name": "國泰世華全球企網銀 (Global MyB2B)"
                        }
                    ],
                    "creator_name": null,
                    "creator_type": null
                }
            ],
            "vendor": {
                "object": "order_transfer.vendor",
                "application_vendor_uuid": "test vendor",
                "uuid": "ven_4a1vlHE3rqPpSZQP5fQFIRc",
                "email": "[email protected]",
                "name": "owlpay vendor through api"
            },
            "created_at": "2022-11-29T07:41:10+00:00",
            "updated_at": "2022-11-29T07:41:10+00:00",
            "description": null,
            "preliminary_note": null,
            "note": null,
            "order_extras": {
                "inclusive": {
                    "total": 0,
                    "items": []
                },
                "exclusive": {
                    "total": 0,
                    "items": []
                }
            },
            "procedures": [
                {
                    "role_name": "平台",
                    "role": "application",
                    "guard": "platform",
                    "name": "",
                    "status": null,
                    "count": null
                },
                {
                    "role_name": "供應商",
                    "role": "owner",
                    "guard": "vendor_user",
                    "name": "owlpay vendor through api ven_4a1vlHE3rqPpSZQP5fQFIRc",
                    "status": null,
                    "count": null
                }
            ],
            "draft_audits": {
                "need_correction": 0,
                "need_check": 0,
                "count": 2
            }
        }
    ],
    "status": 200
}

Next steps

  • Learn more about Reconciliations API details.
  • Your team can review reconciliation orders on the OwlPay Platform.
    • This step is optional
    • There are no review-related APIs now. Refer to OwlPay Review to access the review function on the OwlPay platform.
  • Make Payout to the vendor on the OwlPay Platform